_

function square(n) {
  return n * n;
}

var wrapped = _([1, 2, 3]);

// Returns an unwrapped value.
wrapped.reduce(_.add);
// => 6

// Returns a wrapped value.
var squares = wrapped.map(square);

_.isArray(squares);
// => false

_.isArray(squares.value());
// => true

Members

(static) add

Description:

• Adds two numbers.

Source:

• node_modules/lodash/add.js, line 18

Since:

• 3.4.0

Example

_.add(6, 4);
// => 10

(static) add

Description:

• Adds two numbers.

Source:

• node_modules/lodash/lodash.js, line 16289

Since:

• 3.4.0

Example

_.add(6, 4);
// => 10

(static) assign

Description:

• Assigns own enumerable string keyed properties of source objects to the destination object. Source objects are applied from left to right. Subsequent sources overwrite property assignments of previous sources. **Note:** This method mutates `object` and is loosely based on [`Object.assign`](https://mdn.io/Object/assign).

Source:

• node_modules/lodash/assign.js, line 46

Since:

• 0.10.0

See:

• _.assignIn

Example

function Foo() {
  this.a = 1;
}

function Bar() {
  this.c = 3;
}

Foo.prototype.b = 2;
Bar.prototype.d = 4;

_.assign({ 'a': 0 }, new Foo, new Bar);
// => { 'a': 1, 'c': 3 }

(static) assign

Description:

• Assigns own enumerable string keyed properties of source objects to the destination object. Source objects are applied from left to right. Subsequent sources overwrite property assignments of previous sources. **Note:** This method mutates `object` and is loosely based on [`Object.assign`](https://mdn.io/Object/assign).

Source:

• node_modules/lodash/core.js, line 3103

Since:

• 0.10.0

See:

• _.assignIn

Example

function Foo() {
  this.a = 1;
}

function Bar() {
  this.c = 3;
}

Foo.prototype.b = 2;
Bar.prototype.d = 4;

_.assign({ 'a': 0 }, new Foo, new Bar);
// => { 'a': 1, 'c': 3 }

(static) assign

Description:

• Assigns own enumerable string keyed properties of source objects to the destination object. Source objects are applied from left to right. Subsequent sources overwrite property assignments of previous sources. **Note:** This method mutates `object` and is loosely based on [`Object.assign`](https://mdn.io/Object/assign).

Source:

• node_modules/lodash/lodash.js, line 12663

Since:

• 0.10.0

See:

• _.assignIn

Example

function Foo() {
  this.a = 1;
}

function Bar() {
  this.c = 3;
}

Foo.prototype.b = 2;
Bar.prototype.d = 4;

_.assign({ 'a': 0 }, new Foo, new Bar);
// => { 'a': 1, 'c': 3 }

(static) assignWith

Description:

• This method is like `_.assign` except that it accepts `customizer` which is invoked to produce the assigned values. If `customizer` returns `undefined`, assignment is handled by the method instead. The `customizer` is invoked with five arguments: (objValue, srcValue, key, object, source). **Note:** This method mutates `object`.

Source:

• node_modules/lodash/assignWith.js, line 33

Since:

• 4.0.0

See:

• _.assignInWith

Example

function customizer(objValue, srcValue) {
  return _.isUndefined(objValue) ? srcValue : objValue;
}

var defaults = _.partialRight(_.assignWith, customizer);

defaults({ 'a': 1 }, { 'b': 2 }, { 'a': 3 });
// => { 'a': 1, 'b': 2 }

(static) assignWith

Description:

• This method is like `_.assign` except that it accepts `customizer` which is invoked to produce the assigned values. If `customizer` returns `undefined`, assignment is handled by the method instead. The `customizer` is invoked with five arguments: (objValue, srcValue, key, object, source). **Note:** This method mutates `object`.

Source:

• node_modules/lodash/lodash.js, line 12771

Since:

• 4.0.0

See:

• _.assignInWith

Example

function customizer(objValue, srcValue) {
  return _.isUndefined(objValue) ? srcValue : objValue;
}

var defaults = _.partialRight(_.assignWith, customizer);

defaults({ 'a': 1 }, { 'b': 2 }, { 'a': 3 });
// => { 'a': 1, 'b': 2 }

(static) at

Description:

• Creates an array of values corresponding to `paths` of `object`.

Source:

• node_modules/lodash/at.js, line 21

Since:

• 1.0.0

Example

var object = { 'a': [{ 'b': { 'c': 3 } }, 4] };

_.at(object, ['a[0].b.c', 'a[1]']);
// => [3, 4]

(static) at

Description:

• This method is the wrapper version of `_.at`.

Source:

• node_modules/lodash/lodash.js, line 8862

Since:

• 1.0.0

Example

var object = { 'a': [{ 'b': { 'c': 3 } }, 4] };

_(object).at(['a[0].b.c', 'a[1]']).value();
// => [3, 4]

(static) at

Description:

• Creates an array of values corresponding to `paths` of `object`.

Source:

• node_modules/lodash/lodash.js, line 12792

Since:

• 1.0.0

Example

var object = { 'a': [{ 'b': { 'c': 3 } }, 4] };

_.at(object, ['a[0].b.c', 'a[1]']);
// => [3, 4]

(static) at

Description:

• This method is the wrapper version of `_.at`.

Source:

• node_modules/lodash/wrapperAt.js, line 8

Since:

• 1.0.0

Example

var object = { 'a': [{ 'b': { 'c': 3 } }, 4] };

_(object).at(['a[0].b.c', 'a[1]']).value();
// => [3, 4]

(static) attempt

Description:

• Attempts to invoke `func`, returning either the result or the caught error object. Any additional arguments are provided to `func` when it's invoked.

Source:

• node_modules/lodash/attempt.js, line 27

Since:

• 3.0.0

Example

// Avoid throwing errors for invalid selectors.
var elements = _.attempt(function(selector) {
  return document.querySelectorAll(selector);
}, '>_>');

if (_.isError(elements)) {
  elements = [];
}

(static) attempt

Description:

• Attempts to invoke `func`, returning either the result or the caught error object. Any additional arguments are provided to `func` when it's invoked.

Source:

• node_modules/lodash/lodash.js, line 15324

Since:

• 3.0.0

Example

// Avoid throwing errors for invalid selectors.
var elements = _.attempt(function(selector) {
  return document.querySelectorAll(selector);
}, '>_>');

if (_.isError(elements)) {
  elements = [];
}

(static) bind

Description:

• Creates a function that invokes `func` with the `this` binding of `thisArg` and `partials` prepended to the arguments it receives. The `_.bind.placeholder` value, which defaults to `_` in monolithic builds, may be used as a placeholder for partially applied arguments. **Note:** Unlike native `Function#bind`, this method doesn't set the "length" property of bound functions.

Source:

• node_modules/lodash/bind.js, line 45

Since:

• 0.1.0

Example

function greet(greeting, punctuation) {
  return greeting + ' ' + this.user + punctuation;
}

var object = { 'user': 'fred' };

var bound = _.bind(greet, object, 'hi');
bound('!');
// => 'hi fred!'

// Bound with placeholders.
var bound = _.bind(greet, object, _, '!');
bound('hi');
// => 'hi fred!'

(static) bind

Description:

• Creates a function that invokes `func` with the `this` binding of `thisArg` and `partials` prepended to the arguments it receives. The `_.bind.placeholder` value, which defaults to `_` in monolithic builds, may be used as a placeholder for partially applied arguments. **Note:** Unlike native `Function#bind`, this method doesn't set the "length" property of bound functions.

Source:

• node_modules/lodash/core.js, line 2299

Since:

• 0.1.0

Example

function greet(greeting, punctuation) {
  return greeting + ' ' + this.user + punctuation;
}

var object = { 'user': 'fred' };

var bound = _.bind(greet, object, 'hi');
bound('!');
// => 'hi fred!'

// Bound with placeholders.
var bound = _.bind(greet, object, _, '!');
bound('hi');
// => 'hi fred!'

(static) bind

Description:

• Creates a function that invokes `func` with the `this` binding of `thisArg` and `partials` prepended to the arguments it receives. The `_.bind.placeholder` value, which defaults to `_` in monolithic builds, may be used as a placeholder for partially applied arguments. **Note:** Unlike native `Function#bind`, this method doesn't set the "length" property of bound functions.

Source:

• node_modules/lodash/lodash.js, line 10162

Since:

• 0.1.0

Example

function greet(greeting, punctuation) {
  return greeting + ' ' + this.user + punctuation;
}

var object = { 'user': 'fred' };

var bound = _.bind(greet, object, 'hi');
bound('!');
// => 'hi fred!'

// Bound with placeholders.
var bound = _.bind(greet, object, _, '!');
bound('hi');
// => 'hi fred!'

(static) bindAll

Description:

• Binds methods of an object to the object itself, overwriting the existing method. **Note:** This method doesn't set the "length" property of bound functions.

Source:

• node_modules/lodash/bindAll.js, line 33

Since:

• 0.1.0

Example

var view = {
  'label': 'docs',
  'click': function() {
    console.log('clicked ' + this.label);
  }
};

_.bindAll(view, ['click']);
jQuery(element).on('click', view.click);
// => Logs 'clicked docs' when clicked.

(static) bindAll

Description:

• Binds methods of an object to the object itself, overwriting the existing method. **Note:** This method doesn't set the "length" property of bound functions.

Source:

• node_modules/lodash/lodash.js, line 15358

Since:

• 0.1.0

Example

var view = {
  'label': 'docs',
  'click': function() {
    console.log('clicked ' + this.label);
  }
};

_.bindAll(view, ['click']);
jQuery(element).on('click', view.click);
// => Logs 'clicked docs' when clicked.

(static) bindKey

Description:

• Creates a function that invokes the method at `object[key]` with `partials` prepended to the arguments it receives. This method differs from `_.bind` by allowing bound functions to reference methods that may be redefined or don't yet exist. See [Peter Michaux's article](http://peter.michaux.ca/articles/lazy-function-definition-pattern) for more details. The `_.bindKey.placeholder` value, which defaults to `_` in monolithic builds, may be used as a placeholder for partially applied arguments.

Source:

• node_modules/lodash/bindKey.js, line 56

Since:

• 0.10.0

Example

var object = {
  'user': 'fred',
  'greet': function(greeting, punctuation) {
    return greeting + ' ' + this.user + punctuation;
  }
};

var bound = _.bindKey(object, 'greet', 'hi');
bound('!');
// => 'hi fred!'

object.greet = function(greeting, punctuation) {
  return greeting + 'ya ' + this.user + punctuation;
};

bound('!');
// => 'hiya fred!'

// Bound with placeholders.
var bound = _.bindKey(object, 'greet', _, '!');
bound('hi');
// => 'hiya fred!'

(static) bindKey

Description:

• Creates a function that invokes the method at `object[key]` with `partials` prepended to the arguments it receives. This method differs from `_.bind` by allowing bound functions to reference methods that may be redefined or don't yet exist. See [Peter Michaux's article](http://peter.michaux.ca/articles/lazy-function-definition-pattern) for more details. The `_.bindKey.placeholder` value, which defaults to `_` in monolithic builds, may be used as a placeholder for partially applied arguments.

Source:

• node_modules/lodash/lodash.js, line 10216

Since:

• 0.10.0

Example

var object = {
  'user': 'fred',
  'greet': function(greeting, punctuation) {
    return greeting + ' ' + this.user + punctuation;
  }
};

var bound = _.bindKey(object, 'greet', 'hi');
bound('!');
// => 'hi fred!'

object.greet = function(greeting, punctuation) {
  return greeting + 'ya ' + this.user + punctuation;
};

bound('!');
// => 'hiya fred!'

// Bound with placeholders.
var bound = _.bindKey(object, 'greet', _, '!');
bound('hi');
// => 'hiya fred!'

(static) camelCase

Description:

• Converts `string` to [camel case](https://en.wikipedia.org/wiki/CamelCase).

Source:

• node_modules/lodash/camelCase.js, line 24

Since:

• 3.0.0

Example

_.camelCase('Foo Bar');
// => 'fooBar'

_.camelCase('--foo-bar--');
// => 'fooBar'

_.camelCase('__FOO_BAR__');
// => 'fooBar'

(static) camelCase

Description:

• Converts `string` to [camel case](https://en.wikipedia.org/wiki/CamelCase).

Source:

• node_modules/lodash/lodash.js, line 14207

Since:

• 3.0.0

Example

_.camelCase('Foo Bar');
// => 'fooBar'

_.camelCase('--foo-bar--');
// => 'fooBar'

_.camelCase('__FOO_BAR__');
// => 'fooBar'

(static) ceil

Description:

• Computes `number` rounded up to `precision`.

Source:

• node_modules/lodash/ceil.js, line 24

Since:

• 3.10.0

Example

_.ceil(4.006);
// => 5

_.ceil(6.004, 2);
// => 6.01

_.ceil(6040, -2);
// => 6100

(static) ceil

Description:

• Computes `number` rounded up to `precision`.

Source:

• node_modules/lodash/lodash.js, line 16314

Since:

• 3.10.0

Example

_.ceil(4.006);
// => 5

_.ceil(6.004, 2);
// => 6.01

_.ceil(6040, -2);
// => 6100

(static) chain

Description:

• Creates a `lodash` wrapper instance with explicit method chain sequences enabled.

Source:

• node_modules/lodash/core.js, line 1817

Since:

• 0.1.0

Example

var users = [
  { 'user': 'barney', 'age': 36 },
  { 'user': 'fred',   'age': 40 }
];

// A sequence without explicit chaining.
_(users).head();
// => { 'user': 'barney', 'age': 36 }

// A sequence with explicit chaining.
_(users)
  .chain()
  .head()
  .pick('user')
  .value();
// => { 'user': 'barney' }

(static) chain

Description:

• Creates a `lodash` wrapper instance with explicit method chain sequences enabled.

Source:

• node_modules/lodash/lodash.js, line 8902

Since:

• 0.1.0

Example

var users = [
  { 'user': 'barney', 'age': 36 },
  { 'user': 'fred',   'age': 40 }
];

// A sequence without explicit chaining.
_(users).head();
// => { 'user': 'barney', 'age': 36 }

// A sequence with explicit chaining.
_(users)
  .chain()
  .head()
  .pick('user')
  .value();
// => { 'user': 'barney' }

(static) chain

Description:

• Creates a `lodash` wrapper instance with explicit method chain sequences enabled.

Source:

• node_modules/lodash/wrapperChain.js, line 3

Since:

• 0.1.0

Example

var users = [
  { 'user': 'barney', 'age': 36 },
  { 'user': 'fred',   'age': 40 }
];

// A sequence without explicit chaining.
_(users).head();
// => { 'user': 'barney', 'age': 36 }

// A sequence with explicit chaining.
_(users)
  .chain()
  .head()
  .pick('user')
  .value();
// => { 'user': 'barney' }

(static) commit

Description:

• Executes the chain sequence and returns the wrapped result.

Source:

• node_modules/lodash/commit.js, line 3

Since:

• 3.2.0

Example

var array = [1, 2];
var wrapped = _(array).push(3);

console.log(array);
// => [1, 2]

wrapped = wrapped.commit();
console.log(array);
// => [1, 2, 3]

wrapped.last();
// => 3

console.log(array);
// => [1, 2, 3]

(static) commit

Description:

• Executes the chain sequence and returns the wrapped result.

Source:

• node_modules/lodash/lodash.js, line 8933

Since:

• 3.2.0

Example

var array = [1, 2];
var wrapped = _(array).push(3);

console.log(array);
// => [1, 2]

wrapped = wrapped.commit();
console.log(array);
// => [1, 2, 3]

wrapped.last();
// => 3

console.log(array);
// => [1, 2, 3]

(static) countBy

Description:

• Creates an object composed of keys generated from the results of running each element of `collection` thru `iteratee`. The corresponding value of each key is the number of times the key was returned by `iteratee`. The iteratee is invoked with one argument: (value).

Source:

• node_modules/lodash/countBy.js, line 32

Since:

• 0.5.0

Example

_.countBy([6.1, 4.2, 6.3], Math.floor);
// => { '4': 1, '6': 2 }

// The `_.property` iteratee shorthand.
_.countBy(['one', 'two', 'three'], 'length');
// => { '3': 2, '5': 1 }

(static) countBy

Description:

• Creates an object composed of keys generated from the results of running each element of `collection` thru `iteratee`. The corresponding value of each key is the number of times the key was returned by `iteratee`. The iteratee is invoked with one argument: (value).

Source:

• node_modules/lodash/lodash.js, line 9141

Since:

• 0.5.0

Example

_.countBy([6.1, 4.2, 6.3], Math.floor);
// => { '4': 1, '6': 2 }

// The `_.property` iteratee shorthand.
_.countBy(['one', 'two', 'three'], 'length');
// => { '3': 2, '5': 1 }

(static) defaults

Description:

• Assigns own and inherited enumerable string keyed properties of source objects to the destination object for all destination properties that resolve to `undefined`. Source objects are applied from left to right. Once a property is set, additional values of the same property are ignored. **Note:** This method mutates `object`.

Source:

• node_modules/lodash/core.js, line 3202

Since:

• 0.1.0

See:

• _.defaultsDeep

Example

_.defaults({ 'a': 1 }, { 'b': 2 }, { 'a': 3 });
// => { 'a': 1, 'b': 2 }

(static) defaults

Description:

• Assigns own and inherited enumerable string keyed properties of source objects to the destination object for all destination properties that resolve to `undefined`. Source objects are applied from left to right. Once a property is set, additional values of the same property are ignored. **Note:** This method mutates `object`.

Source:

• node_modules/lodash/defaults.js, line 33

Since:

• 0.1.0

See:

• _.defaultsDeep

Example

_.defaults({ 'a': 1 }, { 'b': 2 }, { 'a': 3 });
// => { 'a': 1, 'b': 2 }

(static) defaults

Description:

• Assigns own and inherited enumerable string keyed properties of source objects to the destination object for all destination properties that resolve to `undefined`. Source objects are applied from left to right. Once a property is set, additional values of the same property are ignored. **Note:** This method mutates `object`.

Source:

• node_modules/lodash/lodash.js, line 12854

Since:

• 0.1.0

See:

• _.defaultsDeep

Example

_.defaults({ 'a': 1 }, { 'b': 2 }, { 'a': 3 });
// => { 'a': 1, 'b': 2 }

(static) defaultsDeep

Description:

• This method is like `_.defaults` except that it recursively assigns default properties. **Note:** This method mutates `object`.

Source:

• node_modules/lodash/defaultsDeep.js, line 25

Since:

• 3.10.0

See:

• _.defaults

Example

_.defaultsDeep({ 'a': { 'b': 2 } }, { 'a': { 'b': 1, 'c': 3 } });
// => { 'a': { 'b': 2, 'c': 3 } }

(static) defaultsDeep

Description:

• This method is like `_.defaults` except that it recursively assigns default properties. **Note:** This method mutates `object`.

Source:

• node_modules/lodash/lodash.js, line 12904

Since:

• 3.10.0

See:

• _.defaults

Example

_.defaultsDeep({ 'a': { 'b': 2 } }, { 'a': { 'b': 1, 'c': 3 } });
// => { 'a': { 'b': 2, 'c': 3 } }

(static) defer

Description:

• Defers invoking the `func` until the current call stack has cleared. Any additional arguments are provided to `func` when it's invoked.

Source:

• node_modules/lodash/core.js, line 2321

Since:

• 0.1.0

Example

_.defer(function(text) {
  console.log(text);
}, 'deferred');
// => Logs 'deferred' after one millisecond.

(static) defer

Description:

• Defers invoking the `func` until the current call stack has cleared. Any additional arguments are provided to `func` when it's invoked.

Source:

• node_modules/lodash/defer.js, line 22

Since:

• 0.1.0

Example

_.defer(function(text) {
  console.log(text);
}, 'deferred');
// => Logs 'deferred' after one millisecond.

(static) defer

Description:

• Defers invoking the `func` until the current call stack has cleared. Any additional arguments are provided to `func` when it's invoked.

Source:

• node_modules/lodash/lodash.js, line 10515

Since:

• 0.1.0

Example

_.defer(function(text) {
  console.log(text);
}, 'deferred');
// => Logs 'deferred' after one millisecond.

(static) delay

Description:

• Invokes `func` after `wait` milliseconds. Any additional arguments are provided to `func` when it's invoked.

Source:

• node_modules/lodash/core.js, line 2344

Since:

• 0.1.0

Example

_.delay(function(text) {
  console.log(text);
}, 1000, 'later');
// => Logs 'later' after one second.

(static) delay

Description:

• Invokes `func` after `wait` milliseconds. Any additional arguments are provided to `func` when it's invoked.

Source:

• node_modules/lodash/delay.js, line 24

Since:

• 0.1.0

Example

_.delay(function(text) {
  console.log(text);
}, 1000, 'later');
// => Logs 'later' after one second.

(static) delay

Description:

• Invokes `func` after `wait` milliseconds. Any additional arguments are provided to `func` when it's invoked.

Source:

• node_modules/lodash/lodash.js, line 10538

Since:

• 0.1.0

Example

_.delay(function(text) {
  console.log(text);
}, 1000, 'later');
// => Logs 'later' after one second.

(static) difference

Description:

• Creates an array of `array` values not included in the other given arrays using [`SameValueZero`](http://ecma-international.org/ecma-262/7.0/#sec-samevaluezero) for equality comparisons. The order and references of result values are determined by the first array. **Note:** Unlike `_.pullAll`, this method returns a new array.

Source:

• node_modules/lodash/difference.js, line 27

Since:

• 0.1.0

See:

• _.without, _.xor

Example

_.difference([2, 1], [2, 3]);
// => [1]

(static) difference

Description:

• Creates an array of `array` values not included in the other given arrays using [`SameValueZero`](http://ecma-international.org/ecma-262/7.0/#sec-samevaluezero) for equality comparisons. The order and references of result values are determined by the first array. **Note:** Unlike `_.pullAll`, this method returns a new array.

Source:

• node_modules/lodash/lodash.js, line 7011

Since:

• 0.1.0

See:

• _.without, _.xor

Example

_.difference([2, 1], [2, 3]);
// => [1]

(static) differenceBy

Description:

• This method is like `_.difference` except that it accepts `iteratee` which is invoked for each element of `array` and `values` to generate the criterion by which they're compared. The order and references of result values are determined by the first array. The iteratee is invoked with one argument: (value). **Note:** Unlike `_.pullAllBy`, this method returns a new array.

Source:

• node_modules/lodash/differenceBy.js, line 34

Since:

• 4.0.0

Example

_.differenceBy([2.1, 1.2], [2.3, 3.4], Math.floor);
// => [1.2]

// The `_.property` iteratee shorthand.
_.differenceBy([{ 'x': 2 }, { 'x': 1 }], [{ 'x': 1 }], 'x');
// => [{ 'x': 2 }]

(static) differenceBy

Description:

• This method is like `_.difference` except that it accepts `iteratee` which is invoked for each element of `array` and `values` to generate the criterion by which they're compared. The order and references of result values are determined by the first array. The iteratee is invoked with one argument: (value). **Note:** Unlike `_.pullAllBy`, this method returns a new array.

Source:

• node_modules/lodash/lodash.js, line 7043

Since:

• 4.0.0

Example

_.differenceBy([2.1, 1.2], [2.3, 3.4], Math.floor);
// => [1.2]

// The `_.property` iteratee shorthand.
_.differenceBy([{ 'x': 2 }, { 'x': 1 }], [{ 'x': 1 }], 'x');
// => [{ 'x': 2 }]

(static) differenceWith

Description:

• This method is like `_.difference` except that it accepts `comparator` which is invoked to compare elements of `array` to `values`. The order and references of result values are determined by the first array. The comparator is invoked with two arguments: (arrVal, othVal). **Note:** Unlike `_.pullAllWith`, this method returns a new array.

Source:

• node_modules/lodash/differenceWith.js, line 30

Since:

• 4.0.0

Example

var objects = [{ 'x': 1, 'y': 2 }, { 'x': 2, 'y': 1 }];

_.differenceWith(objects, [{ 'x': 1, 'y': 2 }], _.isEqual);
// => [{ 'x': 2, 'y': 1 }]

(static) differenceWith

Description:

• This method is like `_.difference` except that it accepts `comparator` which is invoked to compare elements of `array` to `values`. The order and references of result values are determined by the first array. The comparator is invoked with two arguments: (arrVal, othVal). **Note:** Unlike `_.pullAllWith`, this method returns a new array.

Source:

• node_modules/lodash/lodash.js, line 7076

Since:

• 4.0.0

Example

var objects = [{ 'x': 1, 'y': 2 }, { 'x': 2, 'y': 1 }];

_.differenceWith(objects, [{ 'x': 1, 'y': 2 }], _.isEqual);
// => [{ 'x': 2, 'y': 1 }]

(static) divide

Description:

• Divide two numbers.

Source:

• node_modules/lodash/divide.js, line 18

Since:

• 4.7.0

Example

_.divide(6, 4);
// => 1.5

(static) divide

Description:

• Divide two numbers.

Source:

• node_modules/lodash/lodash.js, line 16331

Since:

• 4.7.0

Example

_.divide(6, 4);
// => 1.5

(static) entries

Description:

• Creates an array of own enumerable string keyed-value pairs for `object` which can be consumed by `_.fromPairs`. If `object` is a map or set, its entries are returned.

Source:

• node_modules/lodash/lodash.js, line 13798

Since:

• 4.0.0

Example

function Foo() {
  this.a = 1;
  this.b = 2;
}

Foo.prototype.c = 3;

_.toPairs(new Foo);
// => [['a', 1], ['b', 2]] (iteration order is not guaranteed)

(static) entries

Description:

• Creates an array of own enumerable string keyed-value pairs for `object` which can be consumed by `_.fromPairs`. If `object` is a map or set, its entries are returned.

Source:

• node_modules/lodash/toPairs.js, line 28

Since:

• 4.0.0

Example

function Foo() {
  this.a = 1;
  this.b = 2;
}

Foo.prototype.c = 3;

_.toPairs(new Foo);
// => [['a', 1], ['b', 2]] (iteration order is not guaranteed)

(static) entriesIn

Description:

• Creates an array of own and inherited enumerable string keyed-value pairs for `object` which can be consumed by `_.fromPairs`. If `object` is a map or set, its entries are returned.

Source:

• node_modules/lodash/lodash.js, line 13824

Since:

• 4.0.0

Example

function Foo() {
  this.a = 1;
  this.b = 2;
}

Foo.prototype.c = 3;

_.toPairsIn(new Foo);
// => [['a', 1], ['b', 2], ['c', 3]] (iteration order is not guaranteed)

(static) entriesIn

Description:

• Creates an array of own and inherited enumerable string keyed-value pairs for `object` which can be consumed by `_.fromPairs`. If `object` is a map or set, its entries are returned.

Source:

• node_modules/lodash/toPairsIn.js, line 28

Since:

• 4.0.0

Example

function Foo() {
  this.a = 1;
  this.b = 2;
}

Foo.prototype.c = 3;

_.toPairsIn(new Foo);
// => [['a', 1], ['b', 2], ['c', 3]] (iteration order is not guaranteed)

(static) extend

Description:

• This method is like `_.assign` except that it iterates over own and inherited source properties. **Note:** This method mutates `object`.

Source:

• node_modules/lodash/assignIn.js, line 36

Since:

• 4.0.0

See:

• _.assign

Example

function Foo() {
  this.a = 1;
}

function Bar() {
  this.c = 3;
}

Foo.prototype.b = 2;
Bar.prototype.d = 4;

_.assignIn({ 'a': 0 }, new Foo, new Bar);
// => { 'a': 1, 'b': 2, 'c': 3, 'd': 4 }

(static) extend

Description:

• This method is like `_.assign` except that it iterates over own and inherited source properties. **Note:** This method mutates `object`.

Source:

• node_modules/lodash/core.js, line 3138

Since:

• 4.0.0

See:

• _.assign

Example

function Foo() {
  this.a = 1;
}

function Bar() {
  this.c = 3;
}

Foo.prototype.b = 2;
Bar.prototype.d = 4;

_.assignIn({ 'a': 0 }, new Foo, new Bar);
// => { 'a': 1, 'b': 2, 'c': 3, 'd': 4 }

(static) extend

Description:

• This method is like `_.assign` except that it iterates over own and inherited source properties. **Note:** This method mutates `object`.

Source:

• node_modules/lodash/lodash.js, line 12706

Since:

• 4.0.0

See:

• _.assign

Example

function Foo() {
  this.a = 1;
}

function Bar() {
  this.c = 3;
}

Foo.prototype.b = 2;
Bar.prototype.d = 4;

_.assignIn({ 'a': 0 }, new Foo, new Bar);
// => { 'a': 1, 'b': 2, 'c': 3, 'd': 4 }

(static) extendWith

Description:

• This method is like `_.assignIn` except that it accepts `customizer` which is invoked to produce the assigned values. If `customizer` returns `undefined`, assignment is handled by the method instead. The `customizer` is invoked with five arguments: (objValue, srcValue, key, object, source). **Note:** This method mutates `object`.

Source:

• node_modules/lodash/assignInWith.js, line 34

Since:

• 4.0.0

See:

• _.assignWith

Example

function customizer(objValue, srcValue) {
  return _.isUndefined(objValue) ? srcValue : objValue;
}

var defaults = _.partialRight(_.assignInWith, customizer);

defaults({ 'a': 1 }, { 'b': 2 }, { 'a': 3 });
// => { 'a': 1, 'b': 2 }

(static) extendWith

Description:

• This method is like `_.assignIn` except that it accepts `customizer` which is invoked to produce the assigned values. If `customizer` returns `undefined`, assignment is handled by the method instead. The `customizer` is invoked with five arguments: (objValue, srcValue, key, object, source). **Note:** This method mutates `object`.

Source:

• node_modules/lodash/lodash.js, line 12739

Since:

• 4.0.0

See:

• _.assignWith

Example

function customizer(objValue, srcValue) {
  return _.isUndefined(objValue) ? srcValue : objValue;
}

var defaults = _.partialRight(_.assignInWith, customizer);

defaults({ 'a': 1 }, { 'b': 2 }, { 'a': 3 });
// => { 'a': 1, 'b': 2 }

(static) find

Description:

• Iterates over elements of `collection`, returning the first element `predicate` returns truthy for. The predicate is invoked with three arguments: (value, index|key, collection).

Source:

• node_modules/lodash/core.js, line 1995

Since:

• 0.1.0

Example

var users = [
  { 'user': 'barney',  'age': 36, 'active': true },
  { 'user': 'fred',    'age': 40, 'active': false },
  { 'user': 'pebbles', 'age': 1,  'active': true }
];

_.find(users, function(o) { return o.age < 40; });
// => object for 'barney'

// The `_.matches` iteratee shorthand.
_.find(users, { 'age': 1, 'active': true });
// => object for 'pebbles'

// The `_.matchesProperty` iteratee shorthand.
_.find(users, ['active', false]);
// => object for 'fred'

// The `_.property` iteratee shorthand.
_.find(users, 'active');
// => object for 'barney'

(static) find

Description:

• Iterates over elements of `collection`, returning the first element `predicate` returns truthy for. The predicate is invoked with three arguments: (value, index|key, collection).

Source:

• node_modules/lodash/find.js, line 40

Since:

• 0.1.0

Example

var users = [
  { 'user': 'barney',  'age': 36, 'active': true },
  { 'user': 'fred',    'age': 40, 'active': false },
  { 'user': 'pebbles', 'age': 1,  'active': true }
];

_.find(users, function(o) { return o.age < 40; });
// => object for 'barney'

// The `_.matches` iteratee shorthand.
_.find(users, { 'age': 1, 'active': true });
// => object for 'pebbles'

// The `_.matchesProperty` iteratee shorthand.
_.find(users, ['active', false]);
// => object for 'fred'

// The `_.property` iteratee shorthand.
_.find(users, 'active');
// => object for 'barney'

(static) find

Description:

• Iterates over elements of `collection`, returning the first element `predicate` returns truthy for. The predicate is invoked with three arguments: (value, index|key, collection).

Source:

• node_modules/lodash/lodash.js, line 9280

Since:

• 0.1.0

Example

var users = [
  { 'user': 'barney',  'age': 36, 'active': true },
  { 'user': 'fred',    'age': 40, 'active': false },
  { 'user': 'pebbles', 'age': 1,  'active': true }
];

_.find(users, function(o) { return o.age < 40; });
// => object for 'barney'

// The `_.matches` iteratee shorthand.
_.find(users, { 'age': 1, 'active': true });
// => object for 'pebbles'

// The `_.matchesProperty` iteratee shorthand.
_.find(users, ['active', false]);
// => object for 'fred'

// The `_.property` iteratee shorthand.
_.find(users, 'active');
// => object for 'barney'

(static) findLast

Description:

• This method is like `_.find` except that it iterates over elements of `collection` from right to left.

Source:

• node_modules/lodash/findLast.js, line 23

Since:

• 2.0.0

Example

_.findLast([1, 2, 3, 4], function(n) {
  return n % 2 == 1;
});
// => 3

(static) findLast

Description:

• This method is like `_.find` except that it iterates over elements of `collection` from right to left.

Source:

• node_modules/lodash/lodash.js, line 9301

Since:

• 2.0.0

Example

_.findLast([1, 2, 3, 4], function(n) {
  return n % 2 == 1;
});
// => 3

(static) floor

Description:

• Computes `number` rounded down to `precision`.

Source:

• node_modules/lodash/floor.js, line 24

Since:

• 3.10.0

Example

_.floor(4.006);
// => 4

_.floor(0.046, 2);
// => 0.04

_.floor(4060, -2);
// => 4000

(static) floor

Description:

• Computes `number` rounded down to `precision`.

Source:

• node_modules/lodash/lodash.js, line 16356

Since:

• 3.10.0

Example

_.floor(4.006);
// => 4

_.floor(0.046, 2);
// => 0.04

_.floor(4060, -2);
// => 4000

(static) flow

Description:

• Creates a function that returns the result of invoking the given functions with the `this` binding of the created function, where each successive invocation is supplied the return value of the previous.

Source:

• node_modules/lodash/flow.js, line 25

Since:

• 3.0.0

See:

• _.flowRight

Example

function square(n) {
  return n * n;
}

var addSquare = _.flow([_.add, square]);
addSquare(1, 2);
// => 9

(static) flow

Description:

• Creates a function that returns the result of invoking the given functions with the `this` binding of the created function, where each successive invocation is supplied the return value of the previous.

Source:

• node_modules/lodash/lodash.js, line 15516

Since:

• 3.0.0

See:

• _.flowRight

Example

function square(n) {
  return n * n;
}

var addSquare = _.flow([_.add, square]);
addSquare(1, 2);
// => 9

(static) flowRight

Description:

• This method is like `_.flow` except that it creates a function that invokes the given functions from right to left.

Source:

• node_modules/lodash/flowRight.js, line 24

Since:

• 3.0.0

See:

• _.flow

Example

function square(n) {
  return n * n;
}

var addSquare = _.flowRight([square, _.add]);
addSquare(1, 2);
// => 9

(static) flowRight

Description:

• This method is like `_.flow` except that it creates a function that invokes the given functions from right to left.

Source:

• node_modules/lodash/lodash.js, line 15539

Since:

• 3.0.0

See:

• _.flow

Example

function square(n) {
  return n * n;
}

var addSquare = _.flowRight([square, _.add]);
addSquare(1, 2);
// => 9

(static) groupBy

Description:

• Creates an object composed of keys generated from the results of running each element of `collection` thru `iteratee`. The order of grouped values is determined by the order they occur in `collection`. The corresponding value of each key is an array of elements responsible for generating the key. The iteratee is invoked with one argument: (value).

Source:

• node_modules/lodash/groupBy.js, line 33

Since:

• 0.1.0

Example

_.groupBy([6.1, 4.2, 6.3], Math.floor);
// => { '4': [4.2], '6': [6.1, 6.3] }

// The `_.property` iteratee shorthand.
_.groupBy(['one', 'two', 'three'], 'length');
// => { '3': ['one', 'two'], '5': ['three'] }

(static) groupBy

Description:

• Creates an object composed of keys generated from the results of running each element of `collection` thru `iteratee`. The order of grouped values is determined by the order they occur in `collection`. The corresponding value of each key is an array of elements responsible for generating the key. The iteratee is invoked with one argument: (value).

Source:

• node_modules/lodash/lodash.js, line 9461

Since:

• 0.1.0

Example

_.groupBy([6.1, 4.2, 6.3], Math.floor);
// => { '4': [4.2], '6': [6.1, 6.3] }

// The `_.property` iteratee shorthand.
_.groupBy(['one', 'two', 'three'], 'length');
// => { '3': ['one', 'two'], '5': ['three'] }

(static) gt

Description:

• Checks if `value` is greater than `other`.

Source:

• node_modules/lodash/gt.js, line 27

Since:

• 3.9.0

See:

• _.lt

Example

_.gt(3, 1);
// => true

_.gt(3, 3);
// => false

_.gt(1, 3);
// => false

(static) gt

Description:

• Checks if `value` is greater than `other`.

Source:

• node_modules/lodash/lodash.js, line 11279

Since:

• 3.9.0

See:

• _.lt

Example

_.gt(3, 1);
// => true

_.gt(3, 3);
// => false

_.gt(1, 3);
// => false

(static) gte

Description:

• Checks if `value` is greater than or equal to `other`.

Source:

• node_modules/lodash/gte.js, line 26

Since:

• 3.9.0

See:

• _.lte

Example

_.gte(3, 1);
// => true

_.gte(3, 3);
// => true

_.gte(1, 3);
// => false

(static) gte

Description:

• Checks if `value` is greater than or equal to `other`.

Source:

• node_modules/lodash/lodash.js, line 11304

Since:

• 3.9.0

See:

• _.lte

Example

_.gte(3, 1);
// => true

_.gte(3, 3);
// => true

_.gte(1, 3);
// => false

(static) intersection

Description:

• Creates an array of unique values that are included in all given arrays using [`SameValueZero`](http://ecma-international.org/ecma-262/7.0/#sec-samevaluezero) for equality comparisons. The order and references of result values are determined by the first array.

Source:

• node_modules/lodash/intersection.js, line 23

Since:

• 0.1.0

Example

_.intersection([2, 1], [2, 3]);
// => [2]

(static) intersection

Description:

• Creates an array of unique values that are included in all given arrays using [`SameValueZero`](http://ecma-international.org/ecma-262/7.0/#sec-samevaluezero) for equality comparisons. The order and references of result values are determined by the first array.

Source:

• node_modules/lodash/lodash.js, line 7562

Since:

• 0.1.0

Example

_.intersection([2, 1], [2, 3]);
// => [2]

(static) intersectionBy

Description:

• This method is like `_.intersection` except that it accepts `iteratee` which is invoked for each element of each `arrays` to generate the criterion by which they're compared. The order and references of result values are determined by the first array. The iteratee is invoked with one argument: (value).

Source:

• node_modules/lodash/intersectionBy.js, line 31

Since:

• 4.0.0

Example

_.intersectionBy([2.1, 1.2], [2.3, 3.4], Math.floor);
// => [2.1]

// The `_.property` iteratee shorthand.
_.intersectionBy([{ 'x': 1 }], [{ 'x': 2 }, { 'x': 1 }], 'x');
// => [{ 'x': 1 }]

(static) intersectionBy

Description:

• This method is like `_.intersection` except that it accepts `iteratee` which is invoked for each element of each `arrays` to generate the criterion by which they're compared. The order and references of result values are determined by the first array. The iteratee is invoked with one argument: (value).

Source:

• node_modules/lodash/lodash.js, line 7592

Since:

• 4.0.0

Example

_.intersectionBy([2.1, 1.2], [2.3, 3.4], Math.floor);
// => [2.1]

// The `_.property` iteratee shorthand.
_.intersectionBy([{ 'x': 1 }], [{ 'x': 2 }, { 'x': 1 }], 'x');
// => [{ 'x': 1 }]

(static) intersectionWith

Description:

• This method is like `_.intersection` except that it accepts `comparator` which is invoked to compare elements of `arrays`. The order and references of result values are determined by the first array. The comparator is invoked with two arguments: (arrVal, othVal).

Source:

• node_modules/lodash/intersectionWith.js, line 28

Since:

• 4.0.0

Example

var objects = [{ 'x': 1, 'y': 2 }, { 'x': 2, 'y': 1 }];
var others = [{ 'x': 1, 'y': 1 }, { 'x': 1, 'y': 2 }];

_.intersectionWith(objects, others, _.isEqual);
// => [{ 'x': 1, 'y': 2 }]

(static) intersectionWith

Description:

• This method is like `_.intersection` except that it accepts `comparator` which is invoked to compare elements of `arrays`. The order and references of result values are determined by the first array. The comparator is invoked with two arguments: (arrVal, othVal).

Source:

• node_modules/lodash/lodash.js, line 7627

Since:

• 4.0.0

Example

var objects = [{ 'x': 1, 'y': 2 }, { 'x': 2, 'y': 1 }];
var others = [{ 'x': 1, 'y': 1 }, { 'x': 1, 'y': 2 }];

_.intersectionWith(objects, others, _.isEqual);
// => [{ 'x': 1, 'y': 2 }]

(static) invert

Description:

• Creates an object composed of the inverted keys and values of `object`. If `object` contains duplicate values, subsequent values overwrite property assignments of previous values.

Source:

• node_modules/lodash/invert.js, line 33

Since:

• 0.7.0

Example

var object = { 'a': 1, 'b': 2, 'c': 1 };

_.invert(object);
// => { '1': 'c', '2': 'b' }

(static) invert

Description:

• Creates an object composed of the inverted keys and values of `object`. If `object` contains duplicate values, subsequent values overwrite property assignments of previous values.

Source:

• node_modules/lodash/lodash.js, line 13278

Since:

• 0.7.0

Example

var object = { 'a': 1, 'b': 2, 'c': 1 };

_.invert(object);
// => { '1': 'c', '2': 'b' }

(static) invertBy

Description:

• This method is like `_.invert` except that the inverted object is generated from the results of running each element of `object` thru `iteratee`. The corresponding inverted value of each inverted key is an array of keys responsible for generating the inverted value. The iteratee is invoked with one argument: (value).

Source:

• node_modules/lodash/invertBy.js, line 43

Since:

• 4.1.0

Example

var object = { 'a': 1, 'b': 2, 'c': 1 };

_.invertBy(object);
// => { '1': ['a', 'c'], '2': ['b'] }

_.invertBy(object, function(value) {
  return 'group' + value;
});
// => { 'group1': ['a', 'c'], 'group2': ['b'] }

(static) invertBy

Description:

• This method is like `_.invert` except that the inverted object is generated from the results of running each element of `object` thru `iteratee`. The corresponding inverted value of each inverted key is an array of keys responsible for generating the inverted value. The iteratee is invoked with one argument: (value).

Source:

• node_modules/lodash/lodash.js, line 13313

Since:

• 4.1.0

Example

var object = { 'a': 1, 'b': 2, 'c': 1 };

_.invertBy(object);
// => { '1': ['a', 'c'], '2': ['b'] }

_.invertBy(object, function(value) {
  return 'group' + value;
});
// => { 'group1': ['a', 'c'], 'group2': ['b'] }

(static) invoke

Description:

• Invokes the method at `path` of `object`.

Source:

• node_modules/lodash/invoke.js, line 22

Since:

• 4.0.0

Example

var object = { 'a': [{ 'b': { 'c': [1, 2, 3, 4] } }] };

_.invoke(object, 'a[0].b.c.slice', 1, 3);
// => [2, 3]

(static) invoke

Description:

• Invokes the method at `path` of `object`.

Source:

• node_modules/lodash/lodash.js, line 13344

Since:

• 4.0.0

Example

var object = { 'a': [{ 'b': { 'c': [1, 2, 3, 4] } }] };

_.invoke(object, 'a[0].b.c.slice', 1, 3);
// => [2, 3]

(static) invokeMap

Description:

• Invokes the method at `path` of each element in `collection`, returning an array of the results of each invoked method. Any additional arguments are provided to each invoked method. If `path` is a function, it's invoked for, and `this` bound to, each element in `collection`.

Source:

• node_modules/lodash/invokeMap.js, line 30

Since:

• 4.0.0

Example

_.invokeMap([[5, 1, 7], [3, 2, 1]], 'sort');
// => [[1, 5, 7], [1, 2, 3]]

_.invokeMap([123, 456], String.prototype.split, '');
// => [['1', '2', '3'], ['4', '5', '6']]

(static) invokeMap

Description:

• Invokes the method at `path` of each element in `collection`, returning an array of the results of each invoked method. Any additional arguments are provided to each invoked method. If `path` is a function, it's invoked for, and `this` bound to, each element in `collection`.

Source:

• node_modules/lodash/lodash.js, line 9535

Since:

• 4.0.0

Example

_.invokeMap([[5, 1, 7], [3, 2, 1]], 'sort');
// => [[1, 5, 7], [1, 2, 3]]

_.invokeMap([123, 456], String.prototype.split, '');
// => [['1', '2', '3'], ['4', '5', '6']]

(static) isArguments

Description:

• Checks if `value` is likely an `arguments` object.

Source:

• node_modules/lodash/core.js, line 2489

Since:

• 0.1.0

Example

_.isArguments(function() { return arguments; }());
// => true

_.isArguments([1, 2, 3]);
// => false

(static) isArguments

Description:

• Checks if `value` is likely an `arguments` object.

Source:

• node_modules/lodash/isArguments.js, line 31

Since:

• 0.1.0

Example

_.isArguments(function() { return arguments; }());
// => true

_.isArguments([1, 2, 3]);
// => false

(static) isArguments

Description:

• Checks if `value` is likely an `arguments` object.

Source:

• node_modules/lodash/lodash.js, line 11326

Since:

• 0.1.0

Example

_.isArguments(function() { return arguments; }());
// => true

_.isArguments([1, 2, 3]);
// => false

(static) isArray

Description:

• Checks if `value` is classified as an `Array` object.

Source:

• node_modules/lodash/core.js, line 2517

Since:

• 0.1.0

Example

_.isArray([1, 2, 3]);
// => true

_.isArray(document.body.children);
// => false

_.isArray('abc');
// => false

_.isArray(_.noop);
// => false

(static) isArray

Description:

• Checks if `value` is classified as an `Array` object.

Source:

• node_modules/lodash/isArray.js, line 24

Since:

• 0.1.0

Example

_.isArray([1, 2, 3]);
// => true

_.isArray(document.body.children);
// => false

_.isArray('abc');
// => false

_.isArray(_.noop);
// => false

(static) isArray

Description:

• Checks if `value` is classified as an `Array` object.

Source:

• node_modules/lodash/lodash.js, line 11354

Since:

• 0.1.0

Example

_.isArray([1, 2, 3]);
// => true

_.isArray(document.body.children);
// => false

_.isArray('abc');
// => false

_.isArray(_.noop);
// => false

(static) isArrayBuffer

Description:

• Checks if `value` is classified as an `ArrayBuffer` object.

Source:

• node_modules/lodash/isArrayBuffer.js, line 25

Since:

• 4.3.0

Example

_.isArrayBuffer(new ArrayBuffer(2));
// => true

_.isArrayBuffer(new Array(2));
// => false

(static) isArrayBuffer

Description:

• Checks if `value` is classified as an `ArrayBuffer` object.

Source:

• node_modules/lodash/lodash.js, line 11373

Since:

• 4.3.0

Example

_.isArrayBuffer(new ArrayBuffer(2));
// => true

_.isArrayBuffer(new Array(2));
// => false

(static) isBuffer

Description:

• Checks if `value` is a buffer.

Source:

• node_modules/lodash/isBuffer.js, line 36

Since:

• 4.3.0

Example

_.isBuffer(new Buffer(2));
// => true

_.isBuffer(new Uint8Array(2));
// => false

(static) isBuffer

Description:

• Checks if `value` is a buffer.

Source:

• node_modules/lodash/lodash.js, line 11472

Since:

• 4.3.0

Example

_.isBuffer(new Buffer(2));
// => true

_.isBuffer(new Uint8Array(2));
// => false

(static) isDate

Description:

• Checks if `value` is classified as a `Date` object.

Source:

• node_modules/lodash/core.js, line 2587

Since:

• 0.1.0

Example

_.isDate(new Date);
// => true

_.isDate('Mon April 23 2012');
// => false

(static) isDate

Description:

• Checks if `value` is classified as a `Date` object.

Source:

• node_modules/lodash/isDate.js, line 25

Since:

• 0.1.0

Example

_.isDate(new Date);
// => true

_.isDate('Mon April 23 2012');
// => false

(static) isDate

Description:

• Checks if `value` is classified as a `Date` object.

Source:

• node_modules/lodash/lodash.js, line 11491

Since:

• 0.1.0

Example

_.isDate(new Date);
// => true

_.isDate('Mon April 23 2012');
// => false

(static) isMap

Description:

• Checks if `value` is classified as a `Map` object.

Source:

• node_modules/lodash/isMap.js, line 25

Since:

• 4.3.0

Example

_.isMap(new Map);
// => true

_.isMap(new WeakMap);
// => false

(static) isMap

Description:

• Checks if `value` is classified as a `Map` object.

Source:

• node_modules/lodash/lodash.js, line 11861

Since:

• 4.3.0

Example

_.isMap(new Map);
// => true

_.isMap(new WeakMap);
// => false

(static) isRegExp

Description:

• Checks if `value` is classified as a `RegExp` object.

Source:

• node_modules/lodash/core.js, line 2913

Since:

• 0.1.0

Example

_.isRegExp(/abc/);
// => true

_.isRegExp('/abc/');
// => false

(static) isRegExp

Description:

• Checks if `value` is classified as a `RegExp` object.

Source:

• node_modules/lodash/isRegExp.js, line 25

Since:

• 0.1.0

Example

_.isRegExp(/abc/);
// => true

_.isRegExp('/abc/');
// => false

(static) isRegExp

Description:

• Checks if `value` is classified as a `RegExp` object.

Source:

• node_modules/lodash/lodash.js, line 12134

Since:

• 0.1.0

Example

_.isRegExp(/abc/);
// => true

_.isRegExp('/abc/');
// => false

(static) isSet

Description:

• Checks if `value` is classified as a `Set` object.

Source:

• node_modules/lodash/isSet.js, line 25

Since:

• 4.3.0

Example

_.isSet(new Set);
// => true

_.isSet(new WeakSet);
// => false

(static) isSet

Description:

• Checks if `value` is classified as a `Set` object.

Source:

• node_modules/lodash/lodash.js, line 12184

Since:

• 4.3.0

Example

_.isSet(new Set);
// => true

_.isSet(new WeakSet);
// => false

(static) isTypedArray

Description:

• Checks if `value` is classified as a typed array.

Source:

• node_modules/lodash/isTypedArray.js, line 25

Since:

• 3.0.0

Example

_.isTypedArray(new Uint8Array);
// => true

_.isTypedArray([]);
// => false

(static) isTypedArray

Description:

• Checks if `value` is classified as a typed array.

Source:

• node_modules/lodash/lodash.js, line 12247

Since:

• 3.0.0

Example

_.isTypedArray(new Uint8Array);
// => true

_.isTypedArray([]);
// => false

(static) iteratee

Description:

• Creates a function that invokes `func` with the arguments of the created function. If `func` is a property name, the created function returns the property value for a given element. If `func` is an array or object, the created function returns `true` for elements that contain the equivalent source properties, otherwise it returns `false`.

Source:

• node_modules/lodash/core.js, line 3508

Since:

• 4.0.0

Example

var users = [
  { 'user': 'barney', 'age': 36, 'active': true },
  { 'user': 'fred',   'age': 40, 'active': false }
];

// The `_.matches` iteratee shorthand.
_.filter(users, _.iteratee({ 'user': 'barney', 'active': true }));
// => [{ 'user': 'barney', 'age': 36, 'active': true }]

// The `_.matchesProperty` iteratee shorthand.
_.filter(users, _.iteratee(['user', 'fred']));
// => [{ 'user': 'fred', 'age': 40 }]

// The `_.property` iteratee shorthand.
_.map(users, _.iteratee('user'));
// => ['barney', 'fred']

// Create custom iteratee shorthands.
_.iteratee = _.wrap(_.iteratee, function(iteratee, func) {
  return !_.isRegExp(func) ? iteratee(func) : function(string) {
    return func.test(string);
  };
});

_.filter(['abc', 'def'], /ef/);
// => ['def']

(static) kebabCase

Description:

• Converts `string` to [kebab case](https://en.wikipedia.org/wiki/Letter_case#Special_case_styles).

Source:

• node_modules/lodash/kebabCase.js, line 24

Since:

• 3.0.0

Example

_.kebabCase('Foo Bar');
// => 'foo-bar'

_.kebabCase('fooBar');
// => 'foo-bar'

_.kebabCase('__FOO_BAR__');
// => 'foo-bar'

(static) kebabCase

Description:

• Converts `string` to [kebab case](https://en.wikipedia.org/wiki/Letter_case#Special_case_styles).

Source:

• node_modules/lodash/lodash.js, line 14369

Since:

• 3.0.0

Example

_.kebabCase('Foo Bar');
// => 'foo-bar'

_.kebabCase('fooBar');
// => 'foo-bar'

_.kebabCase('__FOO_BAR__');
// => 'foo-bar'

(static) keyBy

Description:

• Creates an object composed of keys generated from the results of running each element of `collection` thru `iteratee`. The corresponding value of each key is the last element responsible for generating the key. The iteratee is invoked with one argument: (value).

Source:

• node_modules/lodash/keyBy.js, line 32

Since:

• 4.0.0

Example

var array = [
  { 'dir': 'left', 'code': 97 },
  { 'dir': 'right', 'code': 100 }
];

_.keyBy(array, function(o) {
  return String.fromCharCode(o.code);
});
// => { 'a': { 'dir': 'left', 'code': 97 }, 'd': { 'dir': 'right', 'code': 100 } }

_.keyBy(array, 'dir');
// => { 'left': { 'dir': 'left', 'code': 97 }, 'right': { 'dir': 'right', 'code': 100 } }

(static) keyBy

Description:

• Creates an object composed of keys generated from the results of running each element of `collection` thru `iteratee`. The corresponding value of each key is the last element responsible for generating the key. The iteratee is invoked with one argument: (value).

Source:

• node_modules/lodash/lodash.js, line 9574

Since:

• 4.0.0

Example

var array = [
  { 'dir': 'left', 'code': 97 },
  { 'dir': 'right', 'code': 100 }
];

_.keyBy(array, function(o) {
  return String.fromCharCode(o.code);
});
// => { 'a': { 'dir': 'left', 'code': 97 }, 'd': { 'dir': 'right', 'code': 100 } }

_.keyBy(array, 'dir');
// => { 'left': { 'dir': 'left', 'code': 97 }, 'right': { 'dir': 'right', 'code': 100 } }

(static) keys

Description:

• Creates an array of the own enumerable property names of `object`. **Note:** Non-object values are coerced to objects. See the [ES spec](http://ecma-international.org/ecma-262/7.0/#sec-object.keys) for more details.

Source:

• node_modules/lodash/core.js, line 3292

Since:

• 0.1.0

Example

function Foo() {
  this.a = 1;
  this.b = 2;
}

Foo.prototype.c = 3;

_.keys(new Foo);
// => ['a', 'b'] (iteration order is not guaranteed)

_.keys('hi');
// => ['0', '1']

(static) keysIn

Description:

• Creates an array of the own and inherited enumerable property names of `object`. **Note:** Non-object values are coerced to objects.

Source:

• node_modules/lodash/core.js, line 3317

Since:

• 3.0.0

Example

function Foo() {
  this.a = 1;
  this.b = 2;
}

Foo.prototype.c = 3;

_.keysIn(new Foo);
// => ['a', 'b', 'c'] (iteration order is not guaranteed)

(static) lowerCase

Description:

• Converts `string`, as space separated words, to lower case.

Source:

• node_modules/lodash/lodash.js, line 14393

Since:

• 4.0.0

Example

_.lowerCase('--Foo-Bar--');
// => 'foo bar'

_.lowerCase('fooBar');
// => 'foo bar'

_.lowerCase('__FOO_BAR__');
// => 'foo bar'

(static) lowerCase

Description:

• Converts `string`, as space separated words, to lower case.

Source:

• node_modules/lodash/lowerCase.js, line 23

Since:

• 4.0.0

Example

_.lowerCase('--Foo-Bar--');
// => 'foo bar'

_.lowerCase('fooBar');
// => 'foo bar'

_.lowerCase('__FOO_BAR__');
// => 'foo bar'

(static) lowerFirst

Description:

• Converts the first character of `string` to lower case.

Source:

• node_modules/lodash/lodash.js, line 14414

Since:

• 4.0.0

Example

_.lowerFirst('Fred');
// => 'fred'

_.lowerFirst('FRED');
// => 'fRED'

(static) lowerFirst

Description:

• Converts the first character of `string` to lower case.

Source:

• node_modules/lodash/lowerFirst.js, line 20

Since:

• 4.0.0

Example

_.lowerFirst('Fred');
// => 'fred'

_.lowerFirst('FRED');
// => 'fRED'

(static) lt

Description:

• Checks if `value` is less than `other`.

Source:

• node_modules/lodash/lodash.js, line 12335

Since:

• 3.9.0

See:

• _.gt

Example

_.lt(1, 3);
// => true

_.lt(3, 3);
// => false

_.lt(3, 1);
// => false

(static) lt

Description:

• Checks if `value` is less than `other`.

Source:

• node_modules/lodash/lt.js, line 27

Since:

• 3.9.0

See:

• _.gt

Example

_.lt(1, 3);
// => true

_.lt(3, 3);
// => false

_.lt(3, 1);
// => false

(static) lte

Description:

• Checks if `value` is less than or equal to `other`.

Source:

• node_modules/lodash/lodash.js, line 12360

Since:

• 3.9.0

See:

• _.gte

Example

_.lte(1, 3);
// => true

_.lte(3, 3);
// => true

_.lte(3, 1);
// => false

(static) lte

Description:

• Checks if `value` is less than or equal to `other`.

Source:

• node_modules/lodash/lte.js, line 26

Since:

• 3.9.0

See:

• _.gte

Example

_.lte(1, 3);
// => true

_.lte(3, 3);
// => true

_.lte(3, 1);
// => false

(static) merge

Description:

• This method is like `_.assign` except that it recursively merges own and inherited enumerable string keyed properties of source objects into the destination object. Source properties that resolve to `undefined` are skipped if a destination value exists. Array and plain object properties are merged recursively. Other objects and value types are overridden by assignment. Source objects are applied from left to right. Subsequent sources overwrite property assignments of previous sources. **Note:** This method mutates `object`.

Source:

• node_modules/lodash/lodash.js, line 13505

Since:

• 0.5.0

Example

var object = {
  'a': [{ 'b': 2 }, { 'd': 4 }]
};

var other = {
  'a': [{ 'c': 3 }, { 'e': 5 }]
};

_.merge(object, other);
// => { 'a': [{ 'b': 2, 'c': 3 }, { 'd': 4, 'e': 5 }] }

(static) merge

Description:

• This method is like `_.assign` except that it recursively merges own and inherited enumerable string keyed properties of source objects into the destination object. Source properties that resolve to `undefined` are skipped if a destination value exists. Array and plain object properties are merged recursively. Other objects and value types are overridden by assignment. Source objects are applied from left to right. Subsequent sources overwrite property assignments of previous sources. **Note:** This method mutates `object`.

Source:

• node_modules/lodash/merge.js, line 35

Since:

• 0.5.0

Example

var object = {
  'a': [{ 'b': 2 }, { 'd': 4 }]
};

var other = {
  'a': [{ 'c': 3 }, { 'e': 5 }]
};

_.merge(object, other);
// => { 'a': [{ 'b': 2, 'c': 3 }, { 'd': 4, 'e': 5 }] }

(static) mergeWith

Description:

• This method is like `_.merge` except that it accepts `customizer` which is invoked to produce the merged values of the destination and source properties. If `customizer` returns `undefined`, merging is handled by the method instead. The `customizer` is invoked with six arguments: (objValue, srcValue, key, object, source, stack). **Note:** This method mutates `object`.

Source:

• node_modules/lodash/lodash.js, line 13540

Since:

• 4.0.0

Example

function customizer(objValue, srcValue) {
  if (_.isArray(objValue)) {
    return objValue.concat(srcValue);
  }
}

var object = { 'a': [1], 'b': [2] };
var other = { 'a': [3], 'b': [4] };

_.mergeWith(object, other, customizer);
// => { 'a': [1, 3], 'b': [2, 4] }

(static) mergeWith

Description:

• This method is like `_.merge` except that it accepts `customizer` which is invoked to produce the merged values of the destination and source properties. If `customizer` returns `undefined`, merging is handled by the method instead. The `customizer` is invoked with six arguments: (objValue, srcValue, key, object, source, stack). **Note:** This method mutates `object`.

Source:

• node_modules/lodash/mergeWith.js, line 35

Since:

• 4.0.0

Example

function customizer(objValue, srcValue) {
  if (_.isArray(objValue)) {
    return objValue.concat(srcValue);
  }
}

var object = { 'a': [1], 'b': [2] };
var other = { 'a': [3], 'b': [4] };

_.mergeWith(object, other, customizer);
// => { 'a': [1, 3], 'b': [2, 4] }

(static) method

Description:

• Creates a function that invokes the method at `path` of a given object. Any additional arguments are provided to the invoked method.

Source:

• node_modules/lodash/lodash.js, line 15707

Since:

• 3.7.0

Example

var objects = [
  { 'a': { 'b': _.constant(2) } },
  { 'a': { 'b': _.constant(1) } }
];

_.map(objects, _.method('a.b'));
// => [2, 1]

_.map(objects, _.method(['a', 'b']));
// => [2, 1]

(static) method

Description:

• Creates a function that invokes the method at `path` of a given object. Any additional arguments are provided to the invoked method.

Source:

• node_modules/lodash/method.js, line 28

Since:

• 3.7.0

Example

var objects = [
  { 'a': { 'b': _.constant(2) } },
  { 'a': { 'b': _.constant(1) } }
];

_.map(objects, _.method('a.b'));
// => [2, 1]

_.map(objects, _.method(['a', 'b']));
// => [2, 1]

(static) methodOf

Description:

• The opposite of `_.method`; this method creates a function that invokes the method at a given path of `object`. Any additional arguments are provided to the invoked method.

Source:

• node_modules/lodash/lodash.js, line 15736

Since:

• 3.7.0

Example

var array = _.times(3, _.constant),
    object = { 'a': array, 'b': array, 'c': array };

_.map(['a[2]', 'c[0]'], _.methodOf(object));
// => [2, 0]

_.map([['a', '2'], ['c', '0']], _.methodOf(object));
// => [2, 0]

(static) methodOf

Description:

• The opposite of `_.method`; this method creates a function that invokes the method at a given path of `object`. Any additional arguments are provided to the invoked method.

Source:

• node_modules/lodash/methodOf.js, line 27

Since:

• 3.7.0

Example

var array = _.times(3, _.constant),
    object = { 'a': array, 'b': array, 'c': array };

_.map(['a[2]', 'c[0]'], _.methodOf(object));
// => [2, 0]

_.map([['a', '2'], ['c', '0']], _.methodOf(object));
// => [2, 0]

(static) multiply

Description:

• Multiply two numbers.

Source:

• node_modules/lodash/lodash.js, line 16524

Since:

• 4.7.0

Example

_.multiply(6, 4);
// => 24

(static) multiply

Description:

• Multiply two numbers.

Source:

• node_modules/lodash/multiply.js, line 18

Since:

• 4.7.0

Example

_.multiply(6, 4);
// => 24

(static) next

Description:

• Gets the next value on a wrapped object following the [iterator protocol](https://mdn.io/iteration_protocols#iterator).

Source:

• node_modules/lodash/lodash.js, line 8963

Since:

• 4.0.0

Example

var wrapped = _([1, 2]);

wrapped.next();
// => { 'done': false, 'value': 1 }

wrapped.next();
// => { 'done': false, 'value': 2 }

wrapped.next();
// => { 'done': true, 'value': undefined }

(static) next

Description:

• Gets the next value on a wrapped object following the [iterator protocol](https://mdn.io/iteration_protocols#iterator).

Source:

• node_modules/lodash/next.js, line 3

Since:

• 4.0.0

Example

var wrapped = _([1, 2]);

wrapped.next();
// => { 'done': false, 'value': 1 }

wrapped.next();
// => { 'done': false, 'value': 2 }

wrapped.next();
// => { 'done': true, 'value': undefined }

(static) now

Description:

• Gets the timestamp of the number of milliseconds that have elapsed since the Unix epoch (1 January 1970 00:00:00 UTC).

Source:

• node_modules/lodash/lodash.js, line 10028

Since:

• 2.4.0

Example

_.defer(function(stamp) {
  console.log(_.now() - stamp);
}, _.now());
// => Logs the number of milliseconds it took for the deferred invocation.

(static) omit

Description:

• The opposite of `_.pick`; this method creates an object composed of the own and inherited enumerable property paths of `object` that are not omitted. **Note:** This method is considerably slower than `_.pick`.

Source:

• node_modules/lodash/lodash.js, line 13564

Since:

• 0.1.0

Example

var object = { 'a': 1, 'b': '2', 'c': 3 };

_.omit(object, ['a', 'c']);
// => { 'b': '2' }

(static) omit

Description:

• The opposite of `_.pick`; this method creates an object composed of the own and inherited enumerable property paths of `object` that are not omitted. **Note:** This method is considerably slower than `_.pick`.

Source:

• node_modules/lodash/omit.js, line 35

Since:

• 0.1.0

Example

var object = { 'a': 1, 'b': '2', 'c': 3 };

_.omit(object, ['a', 'c']);
// => { 'b': '2' }

(static) over

Description:

• Creates a function that invokes `iteratees` with the arguments it receives and returns their results.

Source:

• node_modules/lodash/lodash.js, line 15895

Since:

• 4.0.0

Example

var func = _.over([Math.max, Math.min]);

func(1, 2, 3, 4);
// => [4, 1]

(static) over

Description:

• Creates a function that invokes `iteratees` with the arguments it receives and returns their results.

Source:

• node_modules/lodash/over.js, line 22

Since:

• 4.0.0

Example

var func = _.over([Math.max, Math.min]);

func(1, 2, 3, 4);
// => [4, 1]

(static) overArgs

Description:

• Creates a function that invokes `func` with its arguments transformed.

Source:

• node_modules/lodash/lodash.js, line 10720

Since:

• 4.0.0

Example

function doubled(n) {
  return n * 2;
}

function square(n) {
  return n * n;
}

var func = _.overArgs(function(x, y) {
  return [x, y];
}, [square, doubled]);

func(9, 3);
// => [81, 6]

func(10, 5);
// => [100, 10]

(static) overArgs

Description:

• Creates a function that invokes `func` with its arguments transformed.

Source:

• node_modules/lodash/overArgs.js, line 44

Since:

• 4.0.0

Example

function doubled(n) {
  return n * 2;
}

function square(n) {
  return n * n;
}

var func = _.overArgs(function(x, y) {
  return [x, y];
}, [square, doubled]);

func(9, 3);
// => [81, 6]

func(10, 5);
// => [100, 10]

(static) overEvery

Description:

• Creates a function that checks if **all** of the `predicates` return truthy when invoked with the arguments it receives. Following shorthands are possible for providing predicates. Pass an `Object` and it will be used as an parameter for `_.matches` to create the predicate. Pass an `Array` of parameters for `_.matchesProperty` and the predicate will be created using them.

Source:

• node_modules/lodash/lodash.js, line 15925

Since:

• 4.0.0

Example

var func = _.overEvery([Boolean, isFinite]);

func('1');
// => true

func(null);
// => false

func(NaN);
// => false

(static) overEvery

Description:

• Creates a function that checks if **all** of the `predicates` return truthy when invoked with the arguments it receives. Following shorthands are possible for providing predicates. Pass an `Object` and it will be used as an parameter for `_.matches` to create the predicate. Pass an `Array` of parameters for `_.matchesProperty` and the predicate will be created using them.

Source:

• node_modules/lodash/overEvery.js, line 32

Since:

• 4.0.0

Example

var func = _.overEvery([Boolean, isFinite]);

func('1');
// => true

func(null);
// => false

func(NaN);
// => false

(static) overSome

Description:

• Creates a function that checks if **any** of the `predicates` return truthy when invoked with the arguments it receives. Following shorthands are possible for providing predicates. Pass an `Object` and it will be used as an parameter for `_.matches` to create the predicate. Pass an `Array` of parameters for `_.matchesProperty` and the predicate will be created using them.

Source:

• node_modules/lodash/lodash.js, line 15958

Since:

• 4.0.0

Example

var func = _.overSome([Boolean, isFinite]);

func('1');
// => true

func(null);
// => true

func(NaN);
// => false

var matchesFunc = _.overSome([{ 'a': 1 }, { 'a': 2 }])
var matchesPropertyFunc = _.overSome([['a', 1], ['a', 2]])

(static) overSome

Description:

• Creates a function that checks if **any** of the `predicates` return truthy when invoked with the arguments it receives. Following shorthands are possible for providing predicates. Pass an `Object` and it will be used as an parameter for `_.matches` to create the predicate. Pass an `Array` of parameters for `_.matchesProperty` and the predicate will be created using them.

Source:

• node_modules/lodash/overSome.js, line 35

Since:

• 4.0.0

Example

var func = _.overSome([Boolean, isFinite]);

func('1');
// => true

func(null);
// => true

func(NaN);
// => false

var matchesFunc = _.overSome([{ 'a': 1 }, { 'a': 2 }])
var matchesPropertyFunc = _.overSome([['a', 1], ['a', 2]])

(static) partial

Description:

• Creates a function that invokes `func` with `partials` prepended to the arguments it receives. This method is like `_.bind` except it does **not** alter the `this` binding. The `_.partial.placeholder` value, which defaults to `_` in monolithic builds, may be used as a placeholder for partially applied arguments. **Note:** This method doesn't set the "length" property of partially applied functions.

Source:

• node_modules/lodash/lodash.js, line 10770

Since:

• 0.2.0

Example

function greet(greeting, name) {
  return greeting + ' ' + name;
}

var sayHelloTo = _.partial(greet, 'hello');
sayHelloTo('fred');
// => 'hello fred'

// Partially applied with placeholders.
var greetFred = _.partial(greet, _, 'fred');
greetFred('hi');
// => 'hi fred'

(static) partial

Description:

• Creates a function that invokes `func` with `partials` prepended to the arguments it receives. This method is like `_.bind` except it does **not** alter the `this` binding. The `_.partial.placeholder` value, which defaults to `_` in monolithic builds, may be used as a placeholder for partially applied arguments. **Note:** This method doesn't set the "length" property of partially applied functions.

Source:

• node_modules/lodash/partial.js, line 42

Since:

• 0.2.0

Example

function greet(greeting, name) {
  return greeting + ' ' + name;
}

var sayHelloTo = _.partial(greet, 'hello');
sayHelloTo('fred');
// => 'hello fred'

// Partially applied with placeholders.
var greetFred = _.partial(greet, _, 'fred');
greetFred('hi');
// => 'hi fred'

(static) partialRight

Description:

• This method is like `_.partial` except that partially applied arguments are appended to the arguments it receives. The `_.partialRight.placeholder` value, which defaults to `_` in monolithic builds, may be used as a placeholder for partially applied arguments. **Note:** This method doesn't set the "length" property of partially applied functions.

Source:

• node_modules/lodash/lodash.js, line 10807

Since:

• 1.0.0

Example

function greet(greeting, name) {
  return greeting + ' ' + name;
}

var greetFred = _.partialRight(greet, 'fred');
greetFred('hi');
// => 'hi fred'

// Partially applied with placeholders.
var sayHelloTo = _.partialRight(greet, 'hello', _);
sayHelloTo('fred');
// => 'hello fred'

(static) partialRight

Description:

• This method is like `_.partial` except that partially applied arguments are appended to the arguments it receives. The `_.partialRight.placeholder` value, which defaults to `_` in monolithic builds, may be used as a placeholder for partially applied arguments. **Note:** This method doesn't set the "length" property of partially applied functions.

Source:

• node_modules/lodash/partialRight.js, line 41

Since:

• 1.0.0

Example

function greet(greeting, name) {
  return greeting + ' ' + name;
}

var greetFred = _.partialRight(greet, 'fred');
greetFred('hi');
// => 'hi fred'

// Partially applied with placeholders.
var sayHelloTo = _.partialRight(greet, 'hello', _);
sayHelloTo('fred');
// => 'hello fred'

(static) partition

Description:

• Creates an array of elements split into two groups, the first of which contains elements `predicate` returns truthy for, the second of which contains elements `predicate` returns falsey for. The predicate is invoked with one argument: (value).

Source:

• node_modules/lodash/lodash.js, line 9704

Since:

• 3.0.0

Example

var users = [
  { 'user': 'barney',  'age': 36, 'active': false },
  { 'user': 'fred',    'age': 40, 'active': true },
  { 'user': 'pebbles', 'age': 1,  'active': false }
];

_.partition(users, function(o) { return o.active; });
// => objects for [['fred'], ['barney', 'pebbles']]

// The `_.matches` iteratee shorthand.
_.partition(users, { 'age': 1, 'active': false });
// => objects for [['pebbles'], ['barney', 'fred']]

// The `_.matchesProperty` iteratee shorthand.
_.partition(users, ['active', false]);
// => objects for [['barney', 'pebbles'], ['fred']]

// The `_.property` iteratee shorthand.
_.partition(users, 'active');
// => objects for [['fred'], ['barney', 'pebbles']]

(static) partition

Description:

• Creates an array of elements split into two groups, the first of which contains elements `predicate` returns truthy for, the second of which contains elements `predicate` returns falsey for. The predicate is invoked with one argument: (value).

Source:

• node_modules/lodash/partition.js, line 39

Since:

• 3.0.0

Example

var users = [
  { 'user': 'barney',  'age': 36, 'active': false },
  { 'user': 'fred',    'age': 40, 'active': true },
  { 'user': 'pebbles', 'age': 1,  'active': false }
];

_.partition(users, function(o) { return o.active; });
// => objects for [['fred'], ['barney', 'pebbles']]

// The `_.matches` iteratee shorthand.
_.partition(users, { 'age': 1, 'active': false });
// => objects for [['pebbles'], ['barney', 'fred']]

// The `_.matchesProperty` iteratee shorthand.
_.partition(users, ['active', false]);
// => objects for [['barney', 'pebbles'], ['fred']]

// The `_.property` iteratee shorthand.
_.partition(users, 'active');
// => objects for [['fred'], ['barney', 'pebbles']]

(static) pick

Description:

• Creates an object composed of the picked `object` properties.

Source:

• node_modules/lodash/core.js, line 3336

Since:

• 0.1.0

Example

var object = { 'a': 1, 'b': '2', 'c': 3 };

_.pick(object, ['a', 'c']);
// => { 'a': 1, 'c': 3 }

(static) pick

Description:

• Creates an object composed of the picked `object` properties.

Source:

• node_modules/lodash/lodash.js, line 13627

Since:

• 0.1.0

Example

var object = { 'a': 1, 'b': '2', 'c': 3 };

_.pick(object, ['a', 'c']);
// => { 'a': 1, 'c': 3 }

(static) pick

Description:

• Creates an object composed of the picked `object` properties.

Source:

• node_modules/lodash/pick.js, line 21

Since:

• 0.1.0

Example

var object = { 'a': 1, 'b': '2', 'c': 3 };

_.pick(object, ['a', 'c']);
// => { 'a': 1, 'c': 3 }

(static) plant

Description:

• Creates a clone of the chain sequence planting `value` as the wrapped value.

Source:

• node_modules/lodash/lodash.js, line 9017

Since:

• 3.2.0

Example

function square(n) {
  return n * n;
}

var wrapped = _([1, 2]).map(square);
var other = wrapped.plant([3, 4]);

other.value();
// => [9, 16]

wrapped.value();
// => [1, 4]

(static) plant

Description:

• Creates a clone of the chain sequence planting `value` as the wrapped value.

Source:

• node_modules/lodash/plant.js, line 4

Since:

• 3.2.0

Example

function square(n) {
  return n * n;
}

var wrapped = _([1, 2]).map(square);
var other = wrapped.plant([3, 4]);

other.value();
// => [9, 16]

wrapped.value();
// => [1, 4]

(static) pull

Description:

• Removes all given values from `array` using [`SameValueZero`](http://ecma-international.org/ecma-262/7.0/#sec-samevaluezero) for equality comparisons. **Note:** Unlike `_.without`, this method mutates `array`. Use `_.remove` to remove elements from an array by predicate.

Source:

• node_modules/lodash/lodash.js, line 7762

Since:

• 2.0.0

Example

var array = ['a', 'b', 'c', 'a', 'b', 'c'];

_.pull(array, 'a', 'c');
console.log(array);
// => ['b', 'b']

(static) pull

Description:

• Removes all given values from `array` using [`SameValueZero`](http://ecma-international.org/ecma-262/7.0/#sec-samevaluezero) for equality comparisons. **Note:** Unlike `_.without`, this method mutates `array`. Use `_.remove` to remove elements from an array by predicate.

Source:

• node_modules/lodash/pull.js, line 27

Since:

• 2.0.0

Example

var array = ['a', 'b', 'c', 'a', 'b', 'c'];

_.pull(array, 'a', 'c');
console.log(array);
// => ['b', 'b']

(static) pullAt

Description:

• Removes elements from `array` corresponding to `indexes` and returns an array of removed elements. **Note:** Unlike `_.at`, this method mutates `array`.

Source:

• node_modules/lodash/lodash.js, line 7872

Since:

• 3.0.0

Example

var array = ['a', 'b', 'c', 'd'];
var pulled = _.pullAt(array, [1, 3]);

console.log(array);
// => ['a', 'c']

console.log(pulled);
// => ['b', 'd']

(static) pullAt

Description:

• Removes elements from `array` corresponding to `indexes` and returns an array of removed elements. **Note:** Unlike `_.at`, this method mutates `array`.

Source:

• node_modules/lodash/pullAt.js, line 32

Since:

• 3.0.0

Example

var array = ['a', 'b', 'c', 'd'];
var pulled = _.pullAt(array, [1, 3]);

console.log(array);
// => ['a', 'c']

console.log(pulled);
// => ['b', 'd']

(static) range

Description:

• Creates an array of numbers (positive and/or negative) progressing from `start` up to, but not including, `end`. A step of `-1` is used if a negative `start` is specified without an `end` or `step`. If `end` is not specified, it's set to `start` with `start` then set to `0`. **Note:** JavaScript follows the IEEE-754 standard for resolving floating-point values which can produce unexpected results.

Source:

• node_modules/lodash/lodash.js, line 16054

Since:

• 0.1.0

See:

• _.inRange, _.rangeRight

Example

_.range(4);
// => [0, 1, 2, 3]

_.range(-4);
// => [0, -1, -2, -3]

_.range(1, 5);
// => [1, 2, 3, 4]

_.range(0, 20, 5);
// => [0, 5, 10, 15]

_.range(0, -4, -1);
// => [0, -1, -2, -3]

_.range(1, 4, 0);
// => [1, 1, 1]

_.range(0);
// => []

(static) range

Description:

• Creates an array of numbers (positive and/or negative) progressing from `start` up to, but not including, `end`. A step of `-1` is used if a negative `start` is specified without an `end` or `step`. If `end` is not specified, it's set to `start` with `start` then set to `0`. **Note:** JavaScript follows the IEEE-754 standard for resolving floating-point values which can produce unexpected results.

Source:

• node_modules/lodash/range.js, line 44

Since:

• 0.1.0

See:

• _.inRange, _.rangeRight

Example

_.range(4);
// => [0, 1, 2, 3]

_.range(-4);
// => [0, -1, -2, -3]

_.range(1, 5);
// => [1, 2, 3, 4]

_.range(0, 20, 5);
// => [0, 5, 10, 15]

_.range(0, -4, -1);
// => [0, -1, -2, -3]

_.range(1, 4, 0);
// => [1, 1, 1]

_.range(0);
// => []

(static) rangeRight

Description:

• This method is like `_.range` except that it populates values in descending order.

Source:

• node_modules/lodash/lodash.js, line 16092

Since:

• 4.0.0

See:

• _.inRange, _.range

Example

_.rangeRight(4);
// => [3, 2, 1, 0]

_.rangeRight(-4);
// => [-3, -2, -1, 0]

_.rangeRight(1, 5);
// => [4, 3, 2, 1]

_.rangeRight(0, 20, 5);
// => [15, 10, 5, 0]

_.rangeRight(0, -4, -1);
// => [-3, -2, -1, 0]

_.rangeRight(1, 4, 0);
// => [1, 1, 1]

_.rangeRight(0);
// => []

(static) rangeRight

Description:

• This method is like `_.range` except that it populates values in descending order.

Source:

• node_modules/lodash/rangeRight.js, line 39

Since:

• 4.0.0

See:

• _.inRange, _.range

Example

_.rangeRight(4);
// => [3, 2, 1, 0]

_.rangeRight(-4);
// => [-3, -2, -1, 0]

_.rangeRight(1, 5);
// => [4, 3, 2, 1]

_.rangeRight(0, 20, 5);
// => [15, 10, 5, 0]

_.rangeRight(0, -4, -1);
// => [-3, -2, -1, 0]

_.rangeRight(1, 4, 0);
// => [1, 1, 1]

_.rangeRight(0);
// => []

(static) rearg

Description:

• Creates a function that invokes `func` with arguments arranged according to the specified `indexes` where the argument value at the first index is provided as the first argument, the argument value at the second index is provided as the second argument, and so on.

Source:

• node_modules/lodash/lodash.js, line 10834

Since:

• 3.0.0

Example

var rearged = _.rearg(function(a, b, c) {
  return [a, b, c];
}, [2, 0, 1]);

rearged('b', 'c', 'a')
// => ['a', 'b', 'c']

(static) rearg

Description:

• Creates a function that invokes `func` with arguments arranged according to the specified `indexes` where the argument value at the first index is provided as the first argument, the argument value at the second index is provided as the second argument, and so on.

Source:

• node_modules/lodash/rearg.js, line 29

Since:

• 3.0.0

Example

var rearged = _.rearg(function(a, b, c) {
  return [a, b, c];
}, [2, 0, 1]);

rearged('b', 'c', 'a')
// => ['a', 'b', 'c']

(static) reverse

Description:

• This method is the wrapper version of `_.reverse`. **Note:** This method mutates the wrapped array.

Source:

• node_modules/lodash/lodash.js, line 9061

Since:

• 0.1.0

Example

var array = [1, 2, 3];

_(array).reverse().value()
// => [3, 2, 1]

console.log(array);
// => [3, 2, 1]

(static) reverse

Description:

• This method is the wrapper version of `_.reverse`. **Note:** This method mutates the wrapped array.

Source:

• node_modules/lodash/wrapperReverse.js, line 6

Since:

• 0.1.0

Example

var array = [1, 2, 3];

_(array).reverse().value()
// => [3, 2, 1]

console.log(array);
// => [3, 2, 1]

(static) round

Description:

• Computes `number` rounded to `precision`.

Source:

• node_modules/lodash/lodash.js, line 16549

Since:

• 3.10.0

Example

_.round(4.006);
// => 4

_.round(4.006, 2);
// => 4.01

_.round(4060, -2);
// => 4100

(static) round

Description:

• Computes `number` rounded to `precision`.

Source:

• node_modules/lodash/round.js, line 24

Since:

• 3.10.0

Example

_.round(4.006);
// => 4

_.round(4.006, 2);
// => 4.01

_.round(4060, -2);
// => 4100

(static) snakeCase

Description:

• Converts `string` to [snake case](https://en.wikipedia.org/wiki/Snake_case).

Source:

• node_modules/lodash/lodash.js, line 14632

Since:

• 3.0.0

Example

_.snakeCase('Foo Bar');
// => 'foo_bar'

_.snakeCase('fooBar');
// => 'foo_bar'

_.snakeCase('--FOO-BAR--');
// => 'foo_bar'

(static) snakeCase

Description:

• Converts `string` to [snake case](https://en.wikipedia.org/wiki/Snake_case).

Source:

• node_modules/lodash/snakeCase.js, line 24

Since:

• 3.0.0

Example

_.snakeCase('Foo Bar');
// => 'foo_bar'

_.snakeCase('fooBar');
// => 'foo_bar'

_.snakeCase('--FOO-BAR--');
// => 'foo_bar'

(static) sortBy

Description:

• Creates an array of elements, sorted in ascending order by the results of running each element in a collection thru each iteratee. This method performs a stable sort, that is, it preserves the original sort order of equal elements. The iteratees are invoked with one argument: (value).

Source:

• node_modules/lodash/lodash.js, line 9997

Since:

• 0.1.0

Example

var users = [
  { 'user': 'fred',   'age': 48 },
  { 'user': 'barney', 'age': 36 },
  { 'user': 'fred',   'age': 30 },
  { 'user': 'barney', 'age': 34 }
];

_.sortBy(users, [function(o) { return o.user; }]);
// => objects for [['barney', 36], ['barney', 34], ['fred', 48], ['fred', 30]]

_.sortBy(users, ['user', 'age']);
// => objects for [['barney', 34], ['barney', 36], ['fred', 30], ['fred', 48]]

(static) sortBy

Description:

• Creates an array of elements, sorted in ascending order by the results of running each element in a collection thru each iteratee. This method performs a stable sort, that is, it preserves the original sort order of equal elements. The iteratees are invoked with one argument: (value).

Source:

• node_modules/lodash/sortBy.js, line 35

Since:

• 0.1.0

Example

var users = [
  { 'user': 'fred',   'age': 48 },
  { 'user': 'barney', 'age': 36 },
  { 'user': 'fred',   'age': 30 },
  { 'user': 'barney', 'age': 34 }
];

_.sortBy(users, [function(o) { return o.user; }]);
// => objects for [['barney', 36], ['barney', 34], ['fred', 48], ['fred', 30]]

_.sortBy(users, ['user', 'age']);
// => objects for [['barney', 34], ['barney', 36], ['fred', 30], ['fred', 48]]

(static) startCase

Description:

• Converts `string` to [start case](https://en.wikipedia.org/wiki/Letter_case#Stylistic_or_specialised_usage).

Source:

• node_modules/lodash/lodash.js, line 14697

Since:

• 3.1.0

Example

_.startCase('--foo-bar--');
// => 'Foo Bar'

_.startCase('fooBar');
// => 'Foo Bar'

_.startCase('__FOO_BAR__');
// => 'FOO BAR'

(static) startCase

Description:

• Converts `string` to [start case](https://en.wikipedia.org/wiki/Letter_case#Stylistic_or_specialised_usage).

Source:

• node_modules/lodash/startCase.js, line 25

Since:

• 3.1.0

Example

_.startCase('--foo-bar--');
// => 'Foo Bar'

_.startCase('fooBar');
// => 'Foo Bar'

_.startCase('__FOO_BAR__');
// => 'FOO BAR'

(static) subtract

Description:

• Subtract two numbers.

Source:

• node_modules/lodash/lodash.js, line 16566

Since:

• 4.0.0

Example

_.subtract(6, 4);
// => 2

(static) subtract

Description:

• Subtract two numbers.

Source:

• node_modules/lodash/subtract.js, line 18

Since:

• 4.0.0

Example

_.subtract(6, 4);
// => 2

(static) templateSettings :Object

Description:

• By default, the template delimiters used by lodash are like those in embedded Ruby (ERB) as well as ES2015 template strings. Change the following template settings to use alternative delimiters.

Source:

• node_modules/lodash/templateSettings.js, line 15

Type:

• Object

(static) toInteger

Description:

• Converts `value` to an integer. **Note:** This method is loosely based on [`ToInteger`](http://www.ecma-international.org/ecma-262/7.0/#sec-tointeger).

Source:

• node_modules/lodash/core.js, line 3014

Since:

• 4.0.0

Example

_.toInteger(3.2);
// => 3

_.toInteger(Number.MIN_VALUE);
// => 0

_.toInteger(Infinity);
// => 1.7976931348623157e+308

_.toInteger('3.2');
// => 3

(static) toNumber

Description:

• Converts `value` to a number.

Source:

• node_modules/lodash/core.js, line 3039

Since:

• 4.0.0

Example

_.toNumber(3.2);
// => 3.2

_.toNumber(Number.MIN_VALUE);
// => 5e-324

_.toNumber(Infinity);
// => Infinity

_.toNumber('3.2');
// => 3.2

(static) union

Description:

• Creates an array of unique values, in order, from all given arrays using [`SameValueZero`](http://ecma-international.org/ecma-262/7.0/#sec-samevaluezero) for equality comparisons.

Source:

• node_modules/lodash/lodash.js, line 8374

Since:

• 0.1.0

Example

_.union([2], [1, 2]);
// => [2, 1]

(static) union

Description:

• Creates an array of unique values, in order, from all given arrays using [`SameValueZero`](http://ecma-international.org/ecma-262/7.0/#sec-samevaluezero) for equality comparisons.

Source:

• node_modules/lodash/union.js, line 22

Since:

• 0.1.0

Example

_.union([2], [1, 2]);
// => [2, 1]

(static) unionBy

Description:

• This method is like `_.union` except that it accepts `iteratee` which is invoked for each element of each `arrays` to generate the criterion by which uniqueness is computed. Result values are chosen from the first array in which the value occurs. The iteratee is invoked with one argument: (value).

Source:

• node_modules/lodash/lodash.js, line 8401

Since:

• 4.0.0

Example

_.unionBy([2.1], [1.2, 2.3], Math.floor);
// => [2.1, 1.2]

// The `_.property` iteratee shorthand.
_.unionBy([{ 'x': 1 }], [{ 'x': 2 }, { 'x': 1 }], 'x');
// => [{ 'x': 1 }, { 'x': 2 }]

(static) unionBy

Description:

• This method is like `_.union` except that it accepts `iteratee` which is invoked for each element of each `arrays` to generate the criterion by which uniqueness is computed. Result values are chosen from the first array in which the value occurs. The iteratee is invoked with one argument: (value).

Source:

• node_modules/lodash/unionBy.js, line 31

Since:

• 4.0.0

Example

_.unionBy([2.1], [1.2, 2.3], Math.floor);
// => [2.1, 1.2]

// The `_.property` iteratee shorthand.
_.unionBy([{ 'x': 1 }], [{ 'x': 2 }, { 'x': 1 }], 'x');
// => [{ 'x': 1 }, { 'x': 2 }]

(static) unionWith

Description:

• This method is like `_.union` except that it accepts `comparator` which is invoked to compare elements of `arrays`. Result values are chosen from the first array in which the value occurs. The comparator is invoked with two arguments: (arrVal, othVal).

Source:

• node_modules/lodash/lodash.js, line 8430

Since:

• 4.0.0

Example

var objects = [{ 'x': 1, 'y': 2 }, { 'x': 2, 'y': 1 }];
var others = [{ 'x': 1, 'y': 1 }, { 'x': 1, 'y': 2 }];

_.unionWith(objects, others, _.isEqual);
// => [{ 'x': 1, 'y': 2 }, { 'x': 2, 'y': 1 }, { 'x': 1, 'y': 1 }]

(static) unionWith

Description:

• This method is like `_.union` except that it accepts `comparator` which is invoked to compare elements of `arrays`. Result values are chosen from the first array in which the value occurs. The comparator is invoked with two arguments: (arrVal, othVal).

Source:

• node_modules/lodash/unionWith.js, line 28

Since:

• 4.0.0

Example

var objects = [{ 'x': 1, 'y': 2 }, { 'x': 2, 'y': 1 }];
var others = [{ 'x': 1, 'y': 1 }, { 'x': 1, 'y': 2 }];

_.unionWith(objects, others, _.isEqual);
// => [{ 'x': 1, 'y': 2 }, { 'x': 2, 'y': 1 }, { 'x': 1, 'y': 1 }]

(static) upperCase

Description:

• Converts `string`, as space separated words, to upper case.

Source:

• node_modules/lodash/lodash.js, line 15248

Since:

• 4.0.0

Example

_.upperCase('--foo-bar');
// => 'FOO BAR'

_.upperCase('fooBar');
// => 'FOO BAR'

_.upperCase('__foo_bar__');
// => 'FOO BAR'

(static) upperCase

Description:

• Converts `string`, as space separated words, to upper case.

Source:

• node_modules/lodash/upperCase.js, line 23

Since:

• 4.0.0

Example

_.upperCase('--foo-bar');
// => 'FOO BAR'

_.upperCase('fooBar');
// => 'FOO BAR'

_.upperCase('__foo_bar__');
// => 'FOO BAR'

(static) upperFirst

Description:

• Converts the first character of `string` to upper case.

Source:

• node_modules/lodash/lodash.js, line 15269

Since:

• 4.0.0

Example

_.upperFirst('fred');
// => 'Fred'

_.upperFirst('FRED');
// => 'FRED'

(static) upperFirst

Description:

• Converts the first character of `string` to upper case.

Source:

• node_modules/lodash/upperFirst.js, line 20

Since:

• 4.0.0

Example

_.upperFirst('fred');
// => 'Fred'

_.upperFirst('FRED');
// => 'FRED'

(static) without

Description:

• Creates an array excluding all given values using [`SameValueZero`](http://ecma-international.org/ecma-262/7.0/#sec-samevaluezero) for equality comparisons. **Note:** Unlike `_.pull`, this method returns a new array.

Source:

• node_modules/lodash/lodash.js, line 8599

Since:

• 0.1.0

See:

• _.difference, _.xor

Example

_.without([2, 1, 2, 3], 1, 2);
// => [3]

(static) without

Description:

• Creates an array excluding all given values using [`SameValueZero`](http://ecma-international.org/ecma-262/7.0/#sec-samevaluezero) for equality comparisons. **Note:** Unlike `_.pull`, this method returns a new array.

Source:

• node_modules/lodash/without.js, line 25

Since:

• 0.1.0

See:

• _.difference, _.xor

Example

_.without([2, 1, 2, 3], 1, 2);
// => [3]

(static) xor

Description:

• Creates an array of unique values that is the [symmetric difference](https://en.wikipedia.org/wiki/Symmetric_difference) of the given arrays. The order of result values is determined by the order they occur in the arrays.

Source:

• node_modules/lodash/lodash.js, line 8623

Since:

• 2.4.0

See:

• _.difference, _.without

Example

_.xor([2, 1], [2, 3]);
// => [1, 3]

(static) xor

Description:

• Creates an array of unique values that is the [symmetric difference](https://en.wikipedia.org/wiki/Symmetric_difference) of the given arrays. The order of result values is determined by the order they occur in the arrays.

Source:

• node_modules/lodash/xor.js, line 24

Since:

• 2.4.0

See:

• _.difference, _.without

Example

_.xor([2, 1], [2, 3]);
// => [1, 3]

(static) xorBy

Description:

• This method is like `_.xor` except that it accepts `iteratee` which is invoked for each element of each `arrays` to generate the criterion by which by which they're compared. The order of result values is determined by the order they occur in the arrays. The iteratee is invoked with one argument: (value).

Source:

• node_modules/lodash/lodash.js, line 8650

Since:

• 4.0.0

Example

_.xorBy([2.1, 1.2], [2.3, 3.4], Math.floor);
// => [1.2, 3.4]

// The `_.property` iteratee shorthand.
_.xorBy([{ 'x': 1 }], [{ 'x': 2 }, { 'x': 1 }], 'x');
// => [{ 'x': 2 }]

(static) xorBy

Description:

• This method is like `_.xor` except that it accepts `iteratee` which is invoked for each element of each `arrays` to generate the criterion by which by which they're compared. The order of result values is determined by the order they occur in the arrays. The iteratee is invoked with one argument: (value).

Source:

• node_modules/lodash/xorBy.js, line 31

Since:

• 4.0.0

Example

_.xorBy([2.1, 1.2], [2.3, 3.4], Math.floor);
// => [1.2, 3.4]

// The `_.property` iteratee shorthand.
_.xorBy([{ 'x': 1 }], [{ 'x': 2 }, { 'x': 1 }], 'x');
// => [{ 'x': 2 }]

(static) xorWith

Description:

• This method is like `_.xor` except that it accepts `comparator` which is invoked to compare elements of `arrays`. The order of result values is determined by the order they occur in the arrays. The comparator is invoked with two arguments: (arrVal, othVal).

Source:

• node_modules/lodash/lodash.js, line 8679

Since:

• 4.0.0

Example

var objects = [{ 'x': 1, 'y': 2 }, { 'x': 2, 'y': 1 }];
var others = [{ 'x': 1, 'y': 1 }, { 'x': 1, 'y': 2 }];

_.xorWith(objects, others, _.isEqual);
// => [{ 'x': 2, 'y': 1 }, { 'x': 1, 'y': 1 }]

(static) xorWith

Description:

• This method is like `_.xor` except that it accepts `comparator` which is invoked to compare elements of `arrays`. The order of result values is determined by the order they occur in the arrays. The comparator is invoked with two arguments: (arrVal, othVal).

Source:

• node_modules/lodash/xorWith.js, line 28

Since:

• 4.0.0

Example

var objects = [{ 'x': 1, 'y': 2 }, { 'x': 2, 'y': 1 }];
var others = [{ 'x': 1, 'y': 1 }, { 'x': 1, 'y': 2 }];

_.xorWith(objects, others, _.isEqual);
// => [{ 'x': 2, 'y': 1 }, { 'x': 1, 'y': 1 }]

(static) zip

Description:

• Creates an array of grouped elements, the first of which contains the first elements of the given arrays, the second of which contains the second elements of the given arrays, and so on.

Source:

• node_modules/lodash/lodash.js, line 8701

Since:

• 0.1.0

Example

_.zip(['a', 'b'], [1, 2], [true, false]);
// => [['a', 1, true], ['b', 2, false]]

(static) zip

Description:

• Creates an array of grouped elements, the first of which contains the first elements of the given arrays, the second of which contains the second elements of the given arrays, and so on.

Source:

• node_modules/lodash/zip.js, line 20

Since:

• 0.1.0

Example

_.zip(['a', 'b'], [1, 2], [true, false]);
// => [['a', 1, true], ['b', 2, false]]

(static) zipWith

Description:

• This method is like `_.zip` except that it accepts `iteratee` to specify how grouped values should be combined. The iteratee is invoked with the elements of each group: (...group).

Source:

• node_modules/lodash/lodash.js, line 8762

Since:

• 3.8.0

Example

_.zipWith([1, 2], [10, 20], [100, 200], function(a, b, c) {
  return a + b + c;
});
// => [111, 222]

(static) zipWith

Description:

• This method is like `_.zip` except that it accepts `iteratee` to specify how grouped values should be combined. The iteratee is invoked with the elements of each group: (...group).

Source:

• node_modules/lodash/zipWith.js, line 24

Since:

• 3.8.0

Example

_.zipWith([1, 2], [10, 20], [100, 200], function(a, b, c) {
  return a + b + c;
});
// => [111, 222]

value

Description:

• Executes the chain sequence to resolve the unwrapped value.

Source:

• node_modules/lodash/core.js, line 1848

Since:

• 0.1.0

Example

_([1, 2, 3]).value();
// => [1, 2, 3]

value

Description:

• Executes the chain sequence to resolve the unwrapped value.

Source:

• node_modules/lodash/lodash.js, line 9099

Since:

• 0.1.0

Example

_([1, 2, 3]).value();
// => [1, 2, 3]

value

Description:

• Executes the chain sequence to resolve the unwrapped value.

Source:

• node_modules/lodash/wrapperValue.js, line 3

Since:

• 0.1.0

Example

_([1, 2, 3]).value();
// => [1, 2, 3]

Methods

(static) after(n, func) → {function}

Description:

• The opposite of `_.before`; this method creates a function that invokes `func` once it's called `n` or more times.

Source:

• node_modules/lodash/after.js, line 30

Since:

• 0.1.0

Example

var saves = ['profile', 'settings'];

var done = _.after(saves.length, function() {
  console.log('done saving!');
});

_.forEach(saves, function(type) {
  asyncSave({ 'type': type, 'complete': done });
});
// => Logs 'done saving!' after the two async saves have completed.

Parameters:

Returns:

Type

function

(static) after(n, func) → {function}

Description:

• The opposite of `_.before`; this method creates a function that invokes `func` once it's called `n` or more times.

Source:

• node_modules/lodash/lodash.js, line 10058

Since:

• 0.1.0

Example

var saves = ['profile', 'settings'];

var done = _.after(saves.length, function() {
  console.log('done saving!');
});

_.forEach(saves, function(type) {
  asyncSave({ 'type': type, 'complete': done });
});
// => Logs 'done saving!' after the two async saves have completed.

Parameters:

Returns:

Type

function

(static) ary(func, nopt) → {function}

Description:

• Creates a function that invokes `func`, with up to `n` arguments, ignoring any additional arguments.

Source:

• node_modules/lodash/ary.js, line 23

Since:

• 3.0.0

Example

_.map(['6', '8', '10'], _.ary(parseInt, 1));
// => [6, 8, 10]

Parameters:

Returns:

Type

function

(static) ary(func, nopt) → {function}

Description:

• Creates a function that invokes `func`, with up to `n` arguments, ignoring any additional arguments.

Source:

• node_modules/lodash/lodash.js, line 10087

Since:

• 3.0.0

Example

_.map(['6', '8', '10'], _.ary(parseInt, 1));
// => [6, 8, 10]

Parameters:

Returns:

Type

function

(static) before(n, func) → {function}

Description:

• Creates a function that invokes `func`, with the `this` binding and arguments of the created function, while it's called less than `n` times. Subsequent calls to the created function return the result of the last `func` invocation.

Source:

• node_modules/lodash/before.js, line 23

Since:

• 3.0.0

Example

jQuery(element).on('click', _.before(5, addContactToList));
// => Allows adding up to 4 contacts to the list.

Parameters:

Returns:

Type

function

(static) before(n, func) → {function}

Description:

• Creates a function that invokes `func`, with the `this` binding and arguments of the created function, while it's called less than `n` times. Subsequent calls to the created function return the result of the last `func` invocation.

Source:

• node_modules/lodash/core.js, line 2247

Since:

• 3.0.0

Example

jQuery(element).on('click', _.before(5, addContactToList));
// => Allows adding up to 4 contacts to the list.

Parameters:

Returns:

Type

function

(static) before(n, func) → {function}

Description:

• Creates a function that invokes `func`, with the `this` binding and arguments of the created function, while it's called less than `n` times. Subsequent calls to the created function return the result of the last `func` invocation.

Source:

• node_modules/lodash/lodash.js, line 10110

Since:

• 3.0.0

Example

jQuery(element).on('click', _.before(5, addContactToList));
// => Allows adding up to 4 contacts to the list.

Parameters:

Returns:

Type

function

(static) capitalize(stringopt) → {string}

Description:

• Converts the first character of `string` to upper case and the remaining to lower case.

Source:

• node_modules/lodash/capitalize.js, line 19

Since:

• 3.0.0

Example

_.capitalize('FRED');
// => 'Fred'

Parameters:

Returns:

Type

string

(static) capitalize(stringopt) → {string}

Description:

• Converts the first character of `string` to upper case and the remaining to lower case.

Source:

• node_modules/lodash/lodash.js, line 14227

Since:

• 3.0.0

Example

_.capitalize('FRED');
// => 'Fred'

Parameters:

Returns:

Type

string

(static) castArray(value) → {Array}

Description:

• Casts `value` as an array if it's not one.

Source:

• node_modules/lodash/castArray.js, line 36

Since:

• 4.4.0

Example

_.castArray(1);
// => [1]

_.castArray({ 'a': 1 });
// => [{ 'a': 1 }]

_.castArray('abc');
// => ['abc']

_.castArray(null);
// => [null]

_.castArray(undefined);
// => [undefined]

_.castArray();
// => []

var array = [1, 2, 3];
console.log(_.castArray(array) === array);
// => true

Parameters:

Returns:

Type

Array

(static) castArray(value) → {Array}

Description:

• Casts `value` as an array if it's not one.

Source:

• node_modules/lodash/lodash.js, line 11063

Since:

• 4.4.0

Example

_.castArray(1);
// => [1]

_.castArray({ 'a': 1 });
// => [{ 'a': 1 }]

_.castArray('abc');
// => ['abc']

_.castArray(null);
// => [null]

_.castArray(undefined);
// => [undefined]

_.castArray();
// => []

var array = [1, 2, 3];
console.log(_.castArray(array) === array);
// => true

Parameters:

Returns:

Type

Array

(static) chain(value) → {Object}

Description:

• Creates a `lodash` wrapper instance that wraps `value` with explicit method chain sequences enabled. The result of such sequences must be unwrapped with `_#value`.

Source:

• node_modules/lodash/chain.js, line 32

Since:

• 1.3.0

Example

var users = [
  { 'user': 'barney',  'age': 36 },
  { 'user': 'fred',    'age': 40 },
  { 'user': 'pebbles', 'age': 1 }
];

var youngest = _
  .chain(users)
  .sortBy('age')
  .map(function(o) {
    return o.user + ' is ' + o.age;
  })
  .head()
  .value();
// => 'pebbles is 1'

Parameters:

Returns:

Type

Object

(static) chain(value) → {Object}

Description:

• Creates a `lodash` wrapper instance that wraps `value` with explicit method chain sequences enabled. The result of such sequences must be unwrapped with `_#value`.

Source:

• node_modules/lodash/core.js, line 1756

Since:

• 1.3.0

Example

var users = [
  { 'user': 'barney',  'age': 36 },
  { 'user': 'fred',    'age': 40 },
  { 'user': 'pebbles', 'age': 1 }
];

var youngest = _
  .chain(users)
  .sortBy('age')
  .map(function(o) {
    return o.user + ' is ' + o.age;
  })
  .head()
  .value();
// => 'pebbles is 1'

Parameters:

Returns:

Type

Object

(static) chain(value) → {Object}

Description:

• Creates a `lodash` wrapper instance that wraps `value` with explicit method chain sequences enabled. The result of such sequences must be unwrapped with `_#value`.

Source:

• node_modules/lodash/lodash.js, line 8801

Since:

• 1.3.0

Example

var users = [
  { 'user': 'barney',  'age': 36 },
  { 'user': 'fred',    'age': 40 },
  { 'user': 'pebbles', 'age': 1 }
];

var youngest = _
  .chain(users)
  .sortBy('age')
  .map(function(o) {
    return o.user + ' is ' + o.age;
  })
  .head()
  .value();
// => 'pebbles is 1'

Parameters:

Returns:

Type

Object

(static) chunk(array, sizeopt) → {Array}

Description:

• Creates an array of elements split into groups the length of `size`. If `array` can't be split evenly, the final chunk will be the remaining elements.

Source:

• node_modules/lodash/chunk.js, line 30

Since:

• 3.0.0

Example

_.chunk(['a', 'b', 'c', 'd'], 2);
// => [['a', 'b'], ['c', 'd']]

_.chunk(['a', 'b', 'c', 'd'], 3);
// => [['a', 'b', 'c'], ['d']]

Parameters:

Returns:

Type

Array

(static) chunk(array, sizeopt) → {Array}

Description:

• Creates an array of elements split into groups the length of `size`. If `array` can't be split evenly, the final chunk will be the remaining elements.

Source:

• node_modules/lodash/lodash.js, line 6903

Since:

• 3.0.0

Example

_.chunk(['a', 'b', 'c', 'd'], 2);
// => [['a', 'b'], ['c', 'd']]

_.chunk(['a', 'b', 'c', 'd'], 3);
// => [['a', 'b', 'c'], ['d']]

Parameters:

Returns:

Type

Array

(static) clamp(number, loweropt, upper) → {number}

Description:

• Clamps `number` within the inclusive `lower` and `upper` bounds.

Source:

• node_modules/lodash/clamp.js, line 23

Since:

• 4.0.0

Example

_.clamp(-10, -5, 5);
// => -5

_.clamp(10, -5, 5);
// => 5

Parameters:

Returns:

Type

number

(static) clamp(number, loweropt, upper) → {number}

Description:

• Clamps `number` within the inclusive `lower` and `upper` bounds.

Source:

• node_modules/lodash/lodash.js, line 14049

Since:

• 4.0.0

Example

_.clamp(-10, -5, 5);
// => -5

_.clamp(10, -5, 5);
// => 5

Parameters:

Returns:

Type

number

(static) clone(value) → {*}

Description:

• Creates a shallow clone of `value`. **Note:** This method is loosely based on the [structured clone algorithm](https://mdn.io/Structured_clone_algorithm) and supports cloning arrays, array buffers, booleans, date objects, maps, numbers, `Object` objects, regexes, sets, strings, symbols, and typed arrays. The own enumerable properties of `arguments` objects are cloned as plain objects. An empty object is returned for uncloneable values such as error objects, functions, DOM nodes, and WeakMaps.

Source:

• node_modules/lodash/clone.js, line 32

Since:

• 0.1.0

See:

• _.cloneDeep

Example

var objects = [{ 'a': 1 }, { 'b': 2 }];

var shallow = _.clone(objects);
console.log(shallow[0] === objects[0]);
// => true

Parameters:

Returns:

Type

*

(static) clone(value) → {*}

Description:

• Creates a shallow clone of `value`. **Note:** This method is loosely based on the [structured clone algorithm](https://mdn.io/Structured_clone_algorithm) and supports cloning arrays, array buffers, booleans, date objects, maps, numbers, `Object` objects, regexes, sets, strings, symbols, and typed arrays. The own enumerable properties of `arguments` objects are cloned as plain objects. An empty object is returned for uncloneable values such as error objects, functions, DOM nodes, and WeakMaps.

Source:

• node_modules/lodash/core.js, line 2428

Since:

• 0.1.0

See:

• _.cloneDeep

Example

var objects = [{ 'a': 1 }, { 'b': 2 }];

var shallow = _.clone(objects);
console.log(shallow[0] === objects[0]);
// => true

Parameters:

Returns:

Type

*

(static) clone(value) → {*}

Description:

• Creates a shallow clone of `value`. **Note:** This method is loosely based on the [structured clone algorithm](https://mdn.io/Structured_clone_algorithm) and supports cloning arrays, array buffers, booleans, date objects, maps, numbers, `Object` objects, regexes, sets, strings, symbols, and typed arrays. The own enumerable properties of `arguments` objects are cloned as plain objects. An empty object is returned for uncloneable values such as error objects, functions, DOM nodes, and WeakMaps.

Source:

• node_modules/lodash/lodash.js, line 11097

Since:

• 0.1.0

See:

• _.cloneDeep

Example

var objects = [{ 'a': 1 }, { 'b': 2 }];

var shallow = _.clone(objects);
console.log(shallow[0] === objects[0]);
// => true

Parameters:

Returns:

Type

*

(static) cloneDeep(value) → {*}

Description:

• This method is like `_.clone` except that it recursively clones `value`.

Source:

• node_modules/lodash/cloneDeep.js, line 25

Since:

• 1.0.0

See:

• _.clone

Example

var objects = [{ 'a': 1 }, { 'b': 2 }];

var deep = _.cloneDeep(objects);
console.log(deep[0] === objects[0]);
// => false

Parameters:

Returns:

Type

*

(static) cloneDeep(value) → {*}

Description:

• This method is like `_.clone` except that it recursively clones `value`.

Source:

• node_modules/lodash/lodash.js, line 11155

Since:

• 1.0.0

See:

• _.clone

Example

var objects = [{ 'a': 1 }, { 'b': 2 }];

var deep = _.cloneDeep(objects);
console.log(deep[0] === objects[0]);
// => false

Parameters:

Returns:

Type

*

(static) cloneDeepWith(value, customizeropt) → {*}

Description:

• This method is like `_.cloneWith` except that it recursively clones `value`.

Source:

• node_modules/lodash/cloneDeepWith.js, line 35

Since:

• 4.0.0

See:

• _.cloneWith

Example

function customizer(value) {
  if (_.isElement(value)) {
    return value.cloneNode(true);
  }
}

var el = _.cloneDeepWith(document.body, customizer);

console.log(el === document.body);
// => false
console.log(el.nodeName);
// => 'BODY'
console.log(el.childNodes.length);
// => 20

Parameters:

Returns:

Type

*

(static) cloneDeepWith(value, customizeropt) → {*}

Description:

• This method is like `_.cloneWith` except that it recursively clones `value`.

Source:

• node_modules/lodash/lodash.js, line 11187

Since:

• 4.0.0

See:

• _.cloneWith

Example

function customizer(value) {
  if (_.isElement(value)) {
    return value.cloneNode(true);
  }
}

var el = _.cloneDeepWith(document.body, customizer);

console.log(el === document.body);
// => false
console.log(el.nodeName);
// => 'BODY'
console.log(el.childNodes.length);
// => 20

Parameters:

Returns:

Type

*

(static) cloneWith(value, customizeropt) → {*}

Description:

• This method is like `_.clone` except that it accepts `customizer` which is invoked to produce the cloned value. If `customizer` returns `undefined`, cloning is handled by the method instead. The `customizer` is invoked with up to four arguments; (value [, index|key, object, stack]).

Source:

• node_modules/lodash/cloneWith.js, line 37

Since:

• 4.0.0

See:

• _.cloneDeepWith

Example

function customizer(value) {
  if (_.isElement(value)) {
    return value.cloneNode(false);
  }
}

var el = _.cloneWith(document.body, customizer);

console.log(el === document.body);
// => false
console.log(el.nodeName);
// => 'BODY'
console.log(el.childNodes.length);
// => 0

Parameters:

Returns:

Type

*

(static) cloneWith(value, customizeropt) → {*}

Description:

• This method is like `_.clone` except that it accepts `customizer` which is invoked to produce the cloned value. If `customizer` returns `undefined`, cloning is handled by the method instead. The `customizer` is invoked with up to four arguments; (value [, index|key, object, stack]).

Source:

• node_modules/lodash/lodash.js, line 11132

Since:

• 4.0.0

See:

• _.cloneDeepWith

Example

function customizer(value) {
  if (_.isElement(value)) {
    return value.cloneNode(false);
  }
}

var el = _.cloneWith(document.body, customizer);

console.log(el === document.body);
// => false
console.log(el.nodeName);
// => 'BODY'
console.log(el.childNodes.length);
// => 0

Parameters:

Returns:

Type

*

(static) compact(array) → {Array}

Description:

• Creates an array with all falsey values removed. The values `false`, `null`, `0`, `""`, `undefined`, and `NaN` are falsey.

Source:

• node_modules/lodash/compact.js, line 16

Since:

• 0.1.0

Example

_.compact([0, 1, false, 2, '', 3]);
// => [1, 2, 3]

Parameters:

Returns:

Type

Array

(static) compact(array) → {Array}

Description:

• Creates an array with all falsey values removed. The values `false`, `null`, `0`, `""`, `undefined`, and `NaN` are falsey.

Source:

• node_modules/lodash/core.js, line 1493

Since:

• 0.1.0

Example

_.compact([0, 1, false, 2, '', 3]);
// => [1, 2, 3]

Parameters:

Returns:

Type

Array

(static) compact(array) → {Array}

Description:

• Creates an array with all falsey values removed. The values `false`, `null`, `0`, `""`, `undefined`, and `NaN` are falsey.

Source:

• node_modules/lodash/lodash.js, line 6938

Since:

• 0.1.0

Example

_.compact([0, 1, false, 2, '', 3]);
// => [1, 2, 3]

Parameters:

Returns:

Type

Array

(static) concat(array, …valuesopt) → {Array}

Description:

• Creates a new array concatenating `array` with any additional arrays and/or values.

Source:

• node_modules/lodash/concat.js, line 28

Since:

• 4.0.0

Example

var array = [1];
var other = _.concat(array, 2, [3], [[4]]);

console.log(other);
// => [1, 2, 3, [4]]

console.log(array);
// => [1]

Parameters:

Returns:

Type

Array

(static) concat(array, …valuesopt) → {Array}

Description:

• Creates a new array concatenating `array` with any additional arrays and/or values.

Source:

• node_modules/lodash/core.js, line 1519

Since:

• 4.0.0

Example

var array = [1];
var other = _.concat(array, 2, [3], [[4]]);

console.log(other);
// => [1, 2, 3, [4]]

console.log(array);
// => [1]

Parameters:

Returns:

Type

Array

(static) concat(array, …valuesopt) → {Array}

Description:

• Creates a new array concatenating `array` with any additional arrays and/or values.

Source:

• node_modules/lodash/lodash.js, line 6975

Since:

• 4.0.0

Example

var array = [1];
var other = _.concat(array, 2, [3], [[4]]);

console.log(other);
// => [1, 2, 3, [4]]

console.log(array);
// => [1]

Parameters:

Returns:

Type

Array

(static) cond(pairs) → {function}

Description:

• Creates a function that iterates over `pairs` and invokes the corresponding function of the first predicate to return truthy. The predicate-function pairs are invoked with the `this` binding and arguments of the created function.

Source:

• node_modules/lodash/cond.js, line 38

Since:

• 4.0.0

Example

var func = _.cond([
  [_.matches({ 'a': 1 }),           _.constant('matches A')],
  [_.conforms({ 'b': _.isNumber }), _.constant('matches B')],
  [_.stubTrue,                      _.constant('no match')]
]);

func({ 'a': 1, 'b': 2 });
// => 'matches A'

func({ 'a': 0, 'b': 1 });
// => 'matches B'

func({ 'a': '1', 'b': '2' });
// => 'no match'

Parameters:

Returns:

Type

function

(static) cond(pairs) → {function}

Description:

• Creates a function that iterates over `pairs` and invokes the corresponding function of the first predicate to return truthy. The predicate-function pairs are invoked with the `this` binding and arguments of the created function.

Source:

• node_modules/lodash/lodash.js, line 15395

Since:

• 4.0.0

Example

var func = _.cond([
  [_.matches({ 'a': 1 }),           _.constant('matches A')],
  [_.conforms({ 'b': _.isNumber }), _.constant('matches B')],
  [_.stubTrue,                      _.constant('no match')]
]);

func({ 'a': 1, 'b': 2 });
// => 'matches A'

func({ 'a': 0, 'b': 1 });
// => 'matches B'

func({ 'a': '1', 'b': '2' });
// => 'no match'

Parameters:

Returns:

Type

function

(static) conforms(source) → {function}

Description:

• Creates a function that invokes the predicate properties of `source` with the corresponding property values of a given object, returning `true` if all predicates return truthy, else `false`. **Note:** The created function is equivalent to `_.conformsTo` with `source` partially applied.

Source:

• node_modules/lodash/conforms.js, line 31

Since:

• 4.0.0

Example

var objects = [
  { 'a': 2, 'b': 1 },
  { 'a': 1, 'b': 2 }
];

_.filter(objects, _.conforms({ 'b': function(n) { return n > 1; } }));
// => [{ 'a': 1, 'b': 2 }]

Parameters:

Returns:

Type

function

(static) conforms(source) → {function}

Description:

• Creates a function that invokes the predicate properties of `source` with the corresponding property values of a given object, returning `true` if all predicates return truthy, else `false`. **Note:** The created function is equivalent to `_.conformsTo` with `source` partially applied.

Source:

• node_modules/lodash/lodash.js, line 15441

Since:

• 4.0.0

Example

var objects = [
  { 'a': 2, 'b': 1 },
  { 'a': 1, 'b': 2 }
];

_.filter(objects, _.conforms({ 'b': function(n) { return n > 1; } }));
// => [{ 'a': 1, 'b': 2 }]

Parameters:

Returns:

Type

function

(static) conformsTo(object, source) → {boolean}

Description:

• Checks if `object` conforms to `source` by invoking the predicate properties of `source` with the corresponding property values of `object`. **Note:** This method is equivalent to `_.conforms` when `source` is partially applied.

Source:

• node_modules/lodash/conformsTo.js, line 28

Since:

• 4.14.0

Example

var object = { 'a': 1, 'b': 2 };

_.conformsTo(object, { 'b': function(n) { return n > 1; } });
// => true

_.conformsTo(object, { 'b': function(n) { return n > 2; } });
// => false

Parameters:

Returns:

Type

boolean

(static) conformsTo(object, source) → {boolean}

Description:

• Checks if `object` conforms to `source` by invoking the predicate properties of `source` with the corresponding property values of `object`. **Note:** This method is equivalent to `_.conforms` when `source` is partially applied.

Source:

• node_modules/lodash/lodash.js, line 11216

Since:

• 4.14.0

Example

var object = { 'a': 1, 'b': 2 };

_.conformsTo(object, { 'b': function(n) { return n > 1; } });
// => true

_.conformsTo(object, { 'b': function(n) { return n > 2; } });
// => false

Parameters:

Returns:

Type

boolean

(static) constant(value) → {function}

Description:

• Creates a function that returns `value`.

Source:

• node_modules/lodash/constant.js, line 20

Since:

• 2.4.0

Example

var objects = _.times(2, _.constant({ 'a': 1 }));

console.log(objects);
// => [{ 'a': 1 }, { 'a': 1 }]

console.log(objects[0] === objects[1]);
// => true

Parameters:

Returns:

Type

function

(static) constant(value) → {function}

Description:

• Creates a function that returns `value`.

Source:

• node_modules/lodash/lodash.js, line 15464

Since:

• 2.4.0

Example

var objects = _.times(2, _.constant({ 'a': 1 }));

console.log(objects);
// => [{ 'a': 1 }, { 'a': 1 }]

console.log(objects[0] === objects[1]);
// => true

Parameters:

Returns:

Type

function

(static) create(prototype, propertiesopt) → {Object}

Description:

• Creates an object that inherits from the `prototype` object. If a `properties` object is given, its own enumerable string keyed properties are assigned to the created object.

Source:

• node_modules/lodash/core.js, line 3176

Since:

• 2.3.0

Example

function Shape() {
  this.x = 0;
  this.y = 0;
}

function Circle() {
  Shape.call(this);
}

Circle.prototype = _.create(Shape.prototype, {
  'constructor': Circle
});

var circle = new Circle;
circle instanceof Circle;
// => true

circle instanceof Shape;
// => true

Parameters:

Returns:

Type

Object

(static) create(prototype, propertiesopt) → {Object}

Description:

• Creates an object that inherits from the `prototype` object. If a `properties` object is given, its own enumerable string keyed properties are assigned to the created object.

Source:

• node_modules/lodash/create.js, line 38

Since:

• 2.3.0

Example

function Shape() {
  this.x = 0;
  this.y = 0;
}

function Circle() {
  Shape.call(this);
}

Circle.prototype = _.create(Shape.prototype, {
  'constructor': Circle
});

var circle = new Circle;
circle instanceof Circle;
// => true

circle instanceof Shape;
// => true

Parameters:

Returns:

Type

Object

(static) create(prototype, propertiesopt) → {Object}

Description:

• Creates an object that inherits from the `prototype` object. If a `properties` object is given, its own enumerable string keyed properties are assigned to the created object.

Source:

• node_modules/lodash/lodash.js, line 12828

Since:

• 2.3.0

Example

function Shape() {
  this.x = 0;
  this.y = 0;
}

function Circle() {
  Shape.call(this);
}

Circle.prototype = _.create(Shape.prototype, {
  'constructor': Circle
});

var circle = new Circle;
circle instanceof Circle;
// => true

circle instanceof Shape;
// => true

Parameters:

Returns:

Type

Object

(static) curry(func, arityopt) → {function}

Description:

• Creates a function that accepts arguments of `func` and either invokes `func` returning its result, if at least `arity` number of arguments have been provided, or returns a function that accepts the remaining `func` arguments, and so on. The arity of `func` may be specified if `func.length` is not sufficient. The `_.curry.placeholder` value, which defaults to `_` in monolithic builds, may be used as a placeholder for provided arguments. **Note:** This method doesn't set the "length" property of curried functions.

Source:

• node_modules/lodash/curry.js, line 47

Since:

• 2.0.0

Example

var abc = function(a, b, c) {
  return [a, b, c];
};

var curried = _.curry(abc);

curried(1)(2)(3);
// => [1, 2, 3]

curried(1, 2)(3);
// => [1, 2, 3]

curried(1, 2, 3);
// => [1, 2, 3]

// Curried with placeholders.
curried(1)(_, 3)(2);
// => [1, 2, 3]

Parameters:

Returns:

Type

function

(static) curry(func, arityopt) → {function}

Description:

• Creates a function that accepts arguments of `func` and either invokes `func` returning its result, if at least `arity` number of arguments have been provided, or returns a function that accepts the remaining `func` arguments, and so on. The arity of `func` may be specified if `func.length` is not sufficient. The `_.curry.placeholder` value, which defaults to `_` in monolithic builds, may be used as a placeholder for provided arguments. **Note:** This method doesn't set the "length" property of curried functions.

Source:

• node_modules/lodash/lodash.js, line 10266

Since:

• 2.0.0

Example

var abc = function(a, b, c) {
  return [a, b, c];
};

var curried = _.curry(abc);

curried(1)(2)(3);
// => [1, 2, 3]

curried(1, 2)(3);
// => [1, 2, 3]

curried(1, 2, 3);
// => [1, 2, 3]

// Curried with placeholders.
curried(1)(_, 3)(2);
// => [1, 2, 3]

Parameters:

Returns:

Type

function

(static) curryRight(func, arityopt) → {function}

Description:

• This method is like `_.curry` except that arguments are applied to `func` in the manner of `_.partialRight` instead of `_.partial`. The `_.curryRight.placeholder` value, which defaults to `_` in monolithic builds, may be used as a placeholder for provided arguments. **Note:** This method doesn't set the "length" property of curried functions.

Source:

• node_modules/lodash/curryRight.js, line 44

Since:

• 3.0.0

Example

var abc = function(a, b, c) {
  return [a, b, c];
};

var curried = _.curryRight(abc);

curried(3)(2)(1);
// => [1, 2, 3]

curried(2, 3)(1);
// => [1, 2, 3]

curried(1, 2, 3);
// => [1, 2, 3]

// Curried with placeholders.
curried(3)(1, _)(2);
// => [1, 2, 3]

Parameters:

Returns:

Type

function

(static) curryRight(func, arityopt) → {function}

Description:

• This method is like `_.curry` except that arguments are applied to `func` in the manner of `_.partialRight` instead of `_.partial`. The `_.curryRight.placeholder` value, which defaults to `_` in monolithic builds, may be used as a placeholder for provided arguments. **Note:** This method doesn't set the "length" property of curried functions.

Source:

• node_modules/lodash/lodash.js, line 10311

Since:

• 3.0.0

Example

var abc = function(a, b, c) {
  return [a, b, c];
};

var curried = _.curryRight(abc);

curried(3)(2)(1);
// => [1, 2, 3]

curried(2, 3)(1);
// => [1, 2, 3]

curried(1, 2, 3);
// => [1, 2, 3]

// Curried with placeholders.
curried(3)(1, _)(2);
// => [1, 2, 3]

Parameters:

Returns:

Type

function

(static) debounce(func, waitopt, optionsopt) → {function}

Description:

• Creates a debounced function that delays invoking `func` until after `wait` milliseconds have elapsed since the last time the debounced function was invoked. The debounced function comes with a `cancel` method to cancel delayed `func` invocations and a `flush` method to immediately invoke them. Provide `options` to indicate whether `func` should be invoked on the leading and/or trailing edge of the `wait` timeout. The `func` is invoked with the last arguments provided to the debounced function. Subsequent calls to the debounced function return the result of the last `func` invocation. **Note:** If `leading` and `trailing` options are `true`, `func` is invoked on the trailing edge of the timeout only if the debounced function is invoked more than once during the `wait` timeout. If `wait` is `0` and `leading` is `false`, `func` invocation is deferred until to the next tick, similar to `setTimeout` with a timeout of `0`. See [David Corbacho's article](https://css-tricks.com/debouncing-throttling-explained-examples/) for details over the differences between `_.debounce` and `_.throttle`.

Source:

• node_modules/lodash/debounce.js, line 66

Since:

• 0.1.0

Example

// Avoid costly calculations while the window size is in flux.
jQuery(window).on('resize', _.debounce(calculateLayout, 150));

// Invoke `sendMail` when clicked, debouncing subsequent calls.
jQuery(element).on('click', _.debounce(sendMail, 300, {
  'leading': true,
  'trailing': false
}));

// Ensure `batchLog` is invoked once after 1 second of debounced calls.
var debounced = _.debounce(batchLog, 250, { 'maxWait': 1000 });
var source = new EventSource('/stream');
jQuery(source).on('message', debounced);

// Cancel the trailing debounced invocation.
jQuery(window).on('popstate', debounced.cancel);

Parameters:

Returns:

Type

function

(static) debounce(func, waitopt, optionsopt) → {function}

Description:

• Creates a debounced function that delays invoking `func` until after `wait` milliseconds have elapsed since the last time the debounced function was invoked. The debounced function comes with a `cancel` method to cancel delayed `func` invocations and a `flush` method to immediately invoke them. Provide `options` to indicate whether `func` should be invoked on the leading and/or trailing edge of the `wait` timeout. The `func` is invoked with the last arguments provided to the debounced function. Subsequent calls to the debounced function return the result of the last `func` invocation. **Note:** If `leading` and `trailing` options are `true`, `func` is invoked on the trailing edge of the timeout only if the debounced function is invoked more than once during the `wait` timeout. If `wait` is `0` and `leading` is `false`, `func` invocation is deferred until to the next tick, similar to `setTimeout` with a timeout of `0`. See [David Corbacho's article](https://css-tricks.com/debouncing-throttling-explained-examples/) for details over the differences between `_.debounce` and `_.throttle`.

Source:

• node_modules/lodash/lodash.js, line 10372

Since:

• 0.1.0

Example

// Avoid costly calculations while the window size is in flux.
jQuery(window).on('resize', _.debounce(calculateLayout, 150));

// Invoke `sendMail` when clicked, debouncing subsequent calls.
jQuery(element).on('click', _.debounce(sendMail, 300, {
  'leading': true,
  'trailing': false
}));

// Ensure `batchLog` is invoked once after 1 second of debounced calls.
var debounced = _.debounce(batchLog, 250, { 'maxWait': 1000 });
var source = new EventSource('/stream');
jQuery(source).on('message', debounced);

// Cancel the trailing debounced invocation.
jQuery(window).on('popstate', debounced.cancel);

Parameters:

Returns:

Type

function

(static) deburr(stringopt) → {string}

Description:

• Deburrs `string` by converting [Latin-1 Supplement](https://en.wikipedia.org/wiki/Latin-1_Supplement_(Unicode_block)#Character_table) and [Latin Extended-A](https://en.wikipedia.org/wiki/Latin_Extended-A) letters to basic Latin letters and removing [combining diacritical marks](https://en.wikipedia.org/wiki/Combining_Diacritical_Marks).

Source:

• node_modules/lodash/deburr.js, line 40

Since:

• 3.0.0

Example

_.deburr('déjà vu');
// => 'deja vu'

Parameters:

Returns:

Type

string

(static) deburr(stringopt) → {string}

Description:

• Deburrs `string` by converting [Latin-1 Supplement](https://en.wikipedia.org/wiki/Latin-1_Supplement_(Unicode_block)#Character_table) and [Latin Extended-A](https://en.wikipedia.org/wiki/Latin_Extended-A) letters to basic Latin letters and removing [combining diacritical marks](https://en.wikipedia.org/wiki/Combining_Diacritical_Marks).

Source:

• node_modules/lodash/lodash.js, line 14249

Since:

• 3.0.0

Example

_.deburr('déjà vu');
// => 'deja vu'

Parameters:

Returns:

Type

string

(static) defaultTo(value, defaultValue) → {*}

Description:

• Checks `value` to determine whether a default value should be returned in its place. The `defaultValue` is returned if `value` is `NaN`, `null`, or `undefined`.

Source:

• node_modules/lodash/defaultTo.js, line 21

Since:

• 4.14.0

Example

_.defaultTo(1, 10);
// => 1

_.defaultTo(undefined, 10);
// => 10

Parameters:

Returns:

Type

*

(static) defaultTo(value, defaultValue) → {*}

Description:

• Checks `value` to determine whether a default value should be returned in its place. The `defaultValue` is returned if `value` is `NaN`, `null`, or `undefined`.

Source:

• node_modules/lodash/lodash.js, line 15490

Since:

• 4.14.0

Example

_.defaultTo(1, 10);
// => 1

_.defaultTo(undefined, 10);
// => 10

Parameters:

Returns:

Type

*

(static) drop(array, nopt) → {Array}

Description:

• Creates a slice of `array` with `n` elements dropped from the beginning.

Source:

• node_modules/lodash/drop.js, line 29

Since:

• 0.5.0

Example

_.drop([1, 2, 3]);
// => [2, 3]

_.drop([1, 2, 3], 2);
// => [3]

_.drop([1, 2, 3], 5);
// => []

_.drop([1, 2, 3], 0);
// => [1, 2, 3]

Parameters:

Returns:

Type

Array

(static) drop(array, nopt) → {Array}

Description:

• Creates a slice of `array` with `n` elements dropped from the beginning.

Source:

• node_modules/lodash/lodash.js, line 7111

Since:

• 0.5.0

Example

_.drop([1, 2, 3]);
// => [2, 3]

_.drop([1, 2, 3], 2);
// => [3]

_.drop([1, 2, 3], 5);
// => []

_.drop([1, 2, 3], 0);
// => [1, 2, 3]

Parameters:

Returns:

Type

Array

(static) dropRight(array, nopt) → {Array}

Description:

• Creates a slice of `array` with `n` elements dropped from the end.

Source:

• node_modules/lodash/dropRight.js, line 29

Since:

• 3.0.0

Example

_.dropRight([1, 2, 3]);
// => [1, 2]

_.dropRight([1, 2, 3], 2);
// => [1]

_.dropRight([1, 2, 3], 5);
// => []

_.dropRight([1, 2, 3], 0);
// => [1, 2, 3]

Parameters:

Returns:

Type

Array

(static) dropRight(array, nopt) → {Array}

Description:

• Creates a slice of `array` with `n` elements dropped from the end.

Source:

• node_modules/lodash/lodash.js, line 7145

Since:

• 3.0.0

Example

_.dropRight([1, 2, 3]);
// => [1, 2]

_.dropRight([1, 2, 3], 2);
// => [1]

_.dropRight([1, 2, 3], 5);
// => []

_.dropRight([1, 2, 3], 0);
// => [1, 2, 3]

Parameters:

Returns:

Type

Array

(static) dropRightWhile(array, predicateopt) → {Array}

Description:

• Creates a slice of `array` excluding elements dropped from the end. Elements are dropped until `predicate` returns falsey. The predicate is invoked with three arguments: (value, index, array).

Source:

• node_modules/lodash/dropRightWhile.js, line 39

Since:

• 3.0.0

Example

var users = [
  { 'user': 'barney',  'active': true },
  { 'user': 'fred',    'active': false },
  { 'user': 'pebbles', 'active': false }
];

_.dropRightWhile(users, function(o) { return !o.active; });
// => objects for ['barney']

// The `_.matches` iteratee shorthand.
_.dropRightWhile(users, { 'user': 'pebbles', 'active': false });
// => objects for ['barney', 'fred']

// The `_.matchesProperty` iteratee shorthand.
_.dropRightWhile(users, ['active', false]);
// => objects for ['barney']

// The `_.property` iteratee shorthand.
_.dropRightWhile(users, 'active');
// => objects for ['barney', 'fred', 'pebbles']

Parameters:

Returns:

Type

Array

(static) dropRightWhile(array, predicateopt) → {Array}

Description:

• Creates a slice of `array` excluding elements dropped from the end. Elements are dropped until `predicate` returns falsey. The predicate is invoked with three arguments: (value, index, array).

Source:

• node_modules/lodash/lodash.js, line 7190

Since:

• 3.0.0

Example

var users = [
  { 'user': 'barney',  'active': true },
  { 'user': 'fred',    'active': false },
  { 'user': 'pebbles', 'active': false }
];

_.dropRightWhile(users, function(o) { return !o.active; });
// => objects for ['barney']

// The `_.matches` iteratee shorthand.
_.dropRightWhile(users, { 'user': 'pebbles', 'active': false });
// => objects for ['barney', 'fred']

// The `_.matchesProperty` iteratee shorthand.
_.dropRightWhile(users, ['active', false]);
// => objects for ['barney']

// The `_.property` iteratee shorthand.
_.dropRightWhile(users, 'active');
// => objects for ['barney', 'fred', 'pebbles']

Parameters:

Returns:

Type

Array

(static) dropWhile(array, predicateopt) → {Array}